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-set-message-modified ((folder
  81                                                        elmo-filter-folder)
  82                                                       modified)
  83   (if (elmo-filter-folder-require-msgdb-internal folder)
  84       (elmo-folder-set-message-modified-internal
  85        (elmo-filter-folder-target-internal folder) modified)
  86     (elmo-folder-set-message-modified-internal folder modified)))
  87
  88 (luna-define-method elmo-folder-commit :around ((folder elmo-filter-folder))
  89   ;; Save target msgdb if it is used.
  90   (if (elmo-filter-folder-require-msgdb-internal folder)
  91       (elmo-folder-commit (elmo-filter-folder-target-internal folder)))
  92   (luna-call-next-method))
  93
  94 (luna-define-method elmo-folder-expand-msgdb-path ((folder
  95                                                     elmo-filter-folder))
  96   (expand-file-name
  97    (elmo-replace-string-as-filename (elmo-folder-name-internal folder))
  98    (expand-file-name "filter" elmo-msgdb-directory)))
  99
 100 (luna-define-method elmo-folder-newsgroups ((folder elmo-filter-folder))
 101   (elmo-folder-newsgroups (elmo-filter-folder-target-internal folder)))
 102
 103 (luna-define-method elmo-find-fetch-strategy
 104   ((folder elmo-filter-folder) entity &optional ignore-cache)
 105   (elmo-find-fetch-strategy
 106    (elmo-filter-folder-target-internal folder)
 107    entity ignore-cache))
 108
 109 (luna-define-method elmo-folder-get-primitive-list ((folder
 110                                                      elmo-filter-folder))
 111   (list (elmo-filter-folder-target-internal folder)))
 112
 113 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
 114                                                type)
 115   (elmo-folder-contains-type
 116    (elmo-filter-folder-target-internal folder)
 117    type))
 118
 119 (luna-define-method elmo-folder-msgdb-create ((folder elmo-filter-folder)
 120                                               numlist flag-table)
 121   (if (elmo-filter-folder-require-msgdb-internal folder)
 122       (let* ((target-folder (elmo-filter-folder-target-internal folder))
 123              (len (length numlist))
 124              (msgdb (elmo-folder-msgdb target-folder))
 125              overview number-alist mark-alist message-id entity mark)
 126         (when (> len elmo-display-progress-threshold)
 127           (elmo-progress-set 'elmo-folder-msgdb-create
 128                              len "Creating msgdb..."))
 129         (unwind-protect
 130             (dolist (number numlist)
 131               (setq entity (elmo-msgdb-overview-get-entity number msgdb))
 132               (when entity
 133                 (setq overview (elmo-msgdb-append-element overview entity)
 134                       message-id (elmo-msgdb-overview-entity-get-id entity)
 135                       number-alist (elmo-msgdb-number-add number-alist
 136                                                           number
 137                                                           message-id))
 138                 (when (setq mark (elmo-msgdb-get-mark msgdb number))
 139                   (setq mark-alist (elmo-msgdb-mark-append
 140                                     mark-alist
 141                                     number
 142                                     mark))))
 143               (elmo-progress-notify 'elmo-folder-msgdb-create))
 144           (elmo-progress-clear 'elmo-folder-msgdb-create))
 145         (list overview number-alist mark-alist))
 146     ;; Does not require msgdb.
 147     (elmo-folder-msgdb-create
 148      (elmo-filter-folder-target-internal folder)
 149      numlist flag-table)))
 150
 151 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
 152                                                &optional flag number)
 153   (elmo-folder-append-buffer
 154    (elmo-filter-folder-target-internal folder)
 155    flag number))
 156
 157 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
 158                                         number strategy
 159                                         &optional section outbuf unseen)
 160   (elmo-message-fetch
 161    (elmo-filter-folder-target-internal folder)
 162    number strategy section outbuf unseen))
 163
 164 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
 165                                                  numbers)
 166   (elmo-folder-delete-messages
 167    (elmo-filter-folder-target-internal folder) numbers))
 168
 169 (luna-define-method elmo-folder-list-messages-internal
 170   ((folder elmo-filter-folder) &optional nohide)
 171   (let ((target (elmo-filter-folder-target-internal folder)))
 172     (if (or (elmo-folder-plugged-p target)
 173             (not (elmo-folder-persistent-p folder)))
 174         ;; search target folder
 175         (elmo-folder-search
 176          target
 177          (elmo-filter-folder-condition-internal folder))
 178       ;; not available
 179       t)))
 180
 181 (defsubst elmo-filter-folder-list-unreads (folder)
 182   (elmo-list-filter
 183    (elmo-folder-list-messages folder nil 'in-msgdb)
 184    (elmo-folder-list-unreads
 185     (elmo-filter-folder-target-internal folder))))
 186
 187 (luna-define-method elmo-folder-list-unreads :around ((folder
 188                                                        elmo-filter-folder))
 189   (if (elmo-filter-folder-require-msgdb-internal folder)
 190       (elmo-filter-folder-list-unreads folder)
 191     (luna-call-next-method)))
 192
 193 (defsubst elmo-filter-folder-list-importants (folder)
 194   (elmo-list-filter
 195    (elmo-folder-list-messages folder nil 'in-msgdb)
 196    (elmo-folder-list-importants
 197     (elmo-filter-folder-target-internal folder))))
 198
 199 (luna-define-method elmo-folder-list-importants :around ((folder
 200                                                           elmo-filter-folder))
 201   (if (elmo-filter-folder-require-msgdb-internal folder)
 202       (elmo-filter-folder-list-importants folder)
 203     (luna-call-next-method)))
 204
 205 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
 206                                                  &optional one-level)
 207   (let* ((target (elmo-filter-folder-target-internal folder))
 208          (prefix (and (string-match
 209                        (concat "^\\(.*\\)"
 210                                (regexp-quote
 211                                 (elmo-folder-name-internal
 212                                  target))
 213                                "$")
 214                        (elmo-folder-name-internal folder))
 215                       (match-string 1 (elmo-folder-name-internal
 216                                        folder)))))
 217     (elmo-mapcar-list-of-list
 218      (lambda (x) (concat prefix x))
 219      (elmo-folder-list-subfolders target one-level))))
 220
 221 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder))
 222   (let ((condition (elmo-filter-folder-condition-internal folder))
 223         diff)
 224     (if (vectorp condition)
 225         (cond
 226          ((and (string= (elmo-filter-key condition) "flag")
 227                (or (string= (elmo-filter-value condition) "any")
 228                    (string= (elmo-filter-value condition) "digest")
 229                    (string= (elmo-filter-value condition) "unread")))
 230           (setq diff (elmo-folder-diff (elmo-filter-folder-target-internal
 231                                         folder)))
 232           (if (consp diff)
 233               (cons (car diff) (car diff))
 234             (cons (car diff) (nth 1 diff))))
 235          ((string= "last" (elmo-filter-key condition))
 236           (luna-call-next-method))
 237          (t
 238           (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
 239                                             folder))))))
 240       (luna-call-next-method))))
 241
 242 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
 243   (elmo-folder-status
 244    (elmo-filter-folder-target-internal folder)))
 245
 246 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
 247   (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
 248
 249 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
 250   (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
 251
 252 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
 253   (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
 254
 255 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
 256   (elmo-folder-create (elmo-filter-folder-target-internal folder)))
 257
 258 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
 259                                         condition &optional numbers)
 260   ;; search from messages in this folder
 261   (elmo-list-filter
 262    numbers
 263    (elmo-folder-search (elmo-filter-folder-target-internal folder)
 264                        condition
 265                        (elmo-folder-list-messages folder))))
 266
 267 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
 268                                               number)
 269   (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
 270                             number))
 271
 272 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
 273   (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
 274
 275 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
 276   (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
 277
 278 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
 279                                              plugged &optional add)
 280   (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
 281                            plugged add))
 282
 283 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
 284                                             number)
 285   (elmo-message-file-name (elmo-filter-folder-target-internal folder)
 286                           number))
 287
 288 (luna-define-method elmo-folder-mark-as-read :around ((folder
 289                                                        elmo-filter-folder)
 290                                                       numbers
 291                                                       &optional ignore-flag)
 292   (elmo-folder-mark-as-read (elmo-filter-folder-target-internal folder)
 293                             numbers ignore-flag)
 294   (luna-call-next-method))
 295
 296 (luna-define-method elmo-folder-unmark-read :around ((folder
 297                                                       elmo-filter-folder)
 298                                                      numbers
 299                                                      &optional ignore-flag)
 300   (elmo-folder-unmark-read (elmo-filter-folder-target-internal folder)
 301                            numbers ignore-flag)
 302   (luna-call-next-method))
 303
 304 (luna-define-method elmo-folder-mark-as-important :around ((folder
 305                                                             elmo-filter-folder)
 306                                                            numbers
 307                                                            &optional
 308                                                            ignore-flag)
 309   (elmo-folder-mark-as-important (elmo-filter-folder-target-internal folder)
 310                                  numbers ignore-flag)
 311     (luna-call-next-method))
 312
 313 (luna-define-method elmo-folder-unmark-important :around ((folder
 314                                                            elmo-filter-folder)
 315                                                           numbers
 316                                                           &optional
 317                                                           ignore-flag)
 318   (elmo-folder-unmark-important (elmo-filter-folder-target-internal folder)
 319                                 numbers ignore-flag)
 320   (luna-call-next-method))
 321
 322 (luna-define-method elmo-folder-mark-as-answered :around ((folder
 323                                                            elmo-filter-folder)
 324                                                           numbers)
 325   (elmo-folder-mark-as-answered (elmo-filter-folder-target-internal folder)
 326                                 numbers)
 327   (luna-call-next-method))
 328
 329
 330 (luna-define-method elmo-folder-unmark-answered :around ((folder
 331                                                           elmo-filter-folder)
 332                                                          numbers)
 333   (elmo-folder-unmark-answered (elmo-filter-folder-target-internal folder)
 334                                numbers)
 335   (luna-call-next-method))
 336
 337 (require 'product)
 338 (product-provide (provide 'elmo-filter) (require 'elmo-version))
 339
 340 ;;; elmo-filter.el ends here