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   (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)))
  69
  70 (luna-define-method elmo-folder-close-internal ((folder elmo-filter-folder))
  71   (elmo-folder-close-internal (elmo-filter-folder-target-internal folder)))
  72
  73 (luna-define-method elmo-folder-close :around ((folder elmo-filter-folder))
  74   ;; Save target msgdb if it is used.
  75   (if (elmo-filter-folder-require-msgdb-internal folder)
  76       (elmo-folder-close (elmo-filter-folder-target-internal folder)))
  77   (luna-call-next-method))
  78
  79 (luna-define-method elmo-folder-commit :around ((folder elmo-filter-folder))
  80   ;; Save target msgdb if it is used.
  81   (if (elmo-filter-folder-require-msgdb-internal folder)
  82       (elmo-folder-commit (elmo-filter-folder-target-internal folder)))
  83   (luna-call-next-method))
  84
  85 (luna-define-method elmo-folder-expand-msgdb-path ((folder
  86                                                     elmo-filter-folder))
  87   (expand-file-name
  88    (elmo-replace-string-as-filename (elmo-folder-name-internal folder))
  89    (expand-file-name "filter" elmo-msgdb-directory)))
  90
  91 (luna-define-method elmo-folder-newsgroups ((folder elmo-filter-folder))
  92   (elmo-folder-newsgroups (elmo-filter-folder-target-internal folder)))
  93
  94 (luna-define-method elmo-find-fetch-strategy
  95   ((folder elmo-filter-folder) entity &optional ignore-cache)
  96   (elmo-find-fetch-strategy
  97    (elmo-filter-folder-target-internal folder)
  98    entity ignore-cache))
  99
 100 (luna-define-method elmo-folder-get-primitive-list ((folder
 101                                                      elmo-filter-folder))
 102   (list (elmo-filter-folder-target-internal folder)))
 103
 104 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
 105                                                type)
 106   (elmo-folder-contains-type
 107    (elmo-filter-folder-target-internal folder)
 108    type))
 109
 110 (luna-define-method elmo-folder-msgdb-create ((folder elmo-filter-folder)
 111                                               numlist seen-list)
 112   (let* ((target-folder (elmo-filter-folder-target-internal folder))
 113          (len (length numlist))
 114          (msgdb (elmo-folder-msgdb target-folder))
 115          overview number-alist mark-alist message-id entity)
 116     (when (> len elmo-display-progress-threshold)
 117       (elmo-progress-set 'elmo-folder-msgdb-create
 118                          len "Creating msgdb..."))
 119     (unwind-protect
 120         (dolist (number numlist)
 121           (setq entity (elmo-msgdb-overview-get-entity number msgdb))
 122           (when entity
 123             (setq overview (elmo-msgdb-append-element overview entity)
 124                   message-id (elmo-msgdb-overview-entity-get-id entity)
 125                   number-alist (elmo-msgdb-number-add number-alist
 126                                                       number
 127                                                       message-id)
 128                   mark-alist (elmo-msgdb-mark-append
 129                               mark-alist
 130                               number
 131                               (elmo-msgdb-get-mark msgdb number))))
 132           (elmo-progress-notify 'elmo-folder-msgdb-create))
 133       (elmo-progress-clear 'elmo-folder-msgdb-create))
 134     (list overview number-alist mark-alist)))
 135
 136 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
 137                                                unread &optional number)
 138   (elmo-folder-append-buffer
 139    (elmo-filter-folder-target-internal folder)
 140    unread 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 ((folder elmo-filter-folder))
 173   (elmo-filter-folder-list-unreads folder))
 174
 175 (defsubst elmo-filter-folder-list-importants (folder)
 176   (elmo-uniq-list
 177    (nconc
 178     (elmo-list-filter
 179      (elmo-folder-list-messages folder nil 'in-msgdb)
 180      (elmo-folder-list-importants
 181       (elmo-filter-folder-target-internal folder)))
 182     (elmo-folder-list-messages-with-global-mark
 183      folder elmo-msgdb-important-mark))))
 184
 185 (luna-define-method elmo-folder-list-importants ((folder elmo-filter-folder))
 186   (elmo-filter-folder-list-importants folder))
 187
 188 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
 189                                                  &optional one-level)
 190   (let* ((target (elmo-filter-folder-target-internal folder))
 191          (prefix (and (string-match
 192                        (concat "^\\(.*\\)"
 193                                (regexp-quote
 194                                 (elmo-folder-name-internal
 195                                  target))
 196                                "$")
 197                        (elmo-folder-name-internal folder))
 198                       (match-string 1 (elmo-folder-name-internal
 199                                        folder)))))
 200     (elmo-mapcar-list-of-list
 201      (lambda (x) (concat prefix x))
 202      (elmo-folder-list-subfolders target one-level))))
 203
 204 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder)
 205                                               &optional numbers)
 206   (if (not (and (vectorp (elmo-filter-folder-condition-internal
 207                           folder))
 208                 (string-match "^last$"
 209                               (elmo-filter-key
 210                                (elmo-filter-folder-condition-internal
 211                                 folder)))))
 212       (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
 213                                         folder))))
 214     (luna-call-next-method)))
 215
 216 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
 217   (elmo-folder-status
 218    (elmo-filter-folder-target-internal folder)))
 219
 220 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
 221   (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
 222
 223 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
 224   (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
 225
 226 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
 227   (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
 228
 229 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
 230   (elmo-folder-create (elmo-filter-folder-target-internal folder)))
 231
 232 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
 233                                         condition &optional numbers)
 234   ;; search from messages in this folder
 235   (elmo-list-filter
 236    numbers
 237    (elmo-folder-search (elmo-filter-folder-target-internal folder)
 238                        condition
 239                        (elmo-folder-list-messages folder))))
 240
 241 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
 242                                               number)
 243   (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
 244                             number))
 245
 246 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
 247   (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
 248
 249 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
 250   (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
 251
 252 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
 253                                              plugged &optional add)
 254   (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
 255                            plugged add))
 256
 257 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
 258                                             number)
 259   (elmo-message-file-name (elmo-filter-folder-target-internal folder)
 260                           number))
 261
 262 (luna-define-method elmo-folder-mark-as-read :around ((folder
 263                                                        elmo-filter-folder)
 264                                                       numbers)
 265   (elmo-folder-mark-as-read (elmo-filter-folder-target-internal folder)
 266                             numbers)
 267   (luna-call-next-method))
 268
 269 (luna-define-method elmo-folder-unmark-read :around ((folder
 270                                                       elmo-filter-folder)
 271                                                      numbers)
 272   (elmo-folder-unmark-read (elmo-filter-folder-target-internal folder)
 273                            numbers)
 274   (luna-call-next-method))
 275
 276 (luna-define-method elmo-folder-mark-as-important :around ((folder
 277                                                             elmo-filter-folder)
 278                                                            numbers)
 279   (elmo-folder-mark-as-important (elmo-filter-folder-target-internal folder)
 280                                  numbers)
 281     (luna-call-next-method))
 282
 283
 284 (luna-define-method elmo-folder-unmark-important :around ((folder
 285                                                            elmo-filter-folder)
 286                                                           numbers)
 287   (elmo-folder-unmark-important (elmo-filter-folder-target-internal folder)
 288                                 numbers)
 289   (luna-call-next-method))
 290
 291 (luna-define-method elmo-folder-mark-as-answered :around ((folder
 292                                                            elmo-filter-folder)
 293                                                           numbers)
 294   (elmo-folder-mark-as-answered (elmo-filter-folder-target-internal folder)
 295                                 numbers)
 296   (luna-call-next-method))
 297
 298
 299 (luna-define-method elmo-folder-unmark-answered :around ((folder
 300                                                           elmo-filter-folder)
 301                                                          numbers)
 302   (elmo-folder-unmark-answered (elmo-filter-folder-target-internal folder)
 303                                numbers)
 304   (luna-call-next-method))
 305
 306 (require 'product)
 307 (product-provide (provide 'elmo-filter) (require 'elmo-version))
 308
 309 ;;; elmo-filter.el ends here