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