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