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