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))
  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     folder))
  51
  52 (luna-define-method elmo-folder-open-internal ((folder elmo-filter-folder))
  53   (elmo-folder-open-internal (elmo-filter-folder-target-internal folder)))
  54
  55 (luna-define-method elmo-folder-check ((folder elmo-filter-folder))
  56   (elmo-folder-check (elmo-filter-folder-target-internal folder)))
  57
  58 (luna-define-method elmo-folder-close-internal ((folder elmo-filter-folder))
  59   (elmo-folder-close-internal (elmo-filter-folder-target-internal folder)))
  60
  61 (luna-define-method elmo-folder-expand-msgdb-path ((folder
  62                                                     elmo-filter-folder))
  63   (expand-file-name
  64    (elmo-replace-string-as-filename (elmo-folder-name-internal folder))
  65    (expand-file-name "filter" elmo-msgdb-directory)))
  66
  67 (luna-define-method elmo-folder-newsgroups ((folder elmo-filter-folder))
  68   (elmo-folder-newsgroups (elmo-filter-folder-target-internal folder)))
  69
  70 (luna-define-method elmo-find-fetch-strategy
  71   ((folder elmo-filter-folder) entity &optional ignore-cache)
  72   (elmo-find-fetch-strategy
  73    (elmo-filter-folder-target-internal folder)
  74    entity ignore-cache))
  75
  76 (luna-define-method elmo-folder-get-primitive-list ((folder
  77                                                      elmo-filter-folder))
  78   (list (elmo-filter-folder-target-internal folder)))
  79
  80 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
  81                                                type)
  82   (elmo-folder-contains-type
  83    (elmo-filter-folder-target-internal folder)
  84    type))
  85
  86 (luna-define-method elmo-folder-msgdb-create ((folder elmo-filter-folder)
  87                                               numlist new-mark already-mark
  88                                               seen-mark important-mark
  89                                               seen-list)
  90   (let ((target-folder (elmo-filter-folder-target-internal folder)))
  91     (if (elmo-folder-plugged-p target-folder)
  92         (elmo-folder-msgdb-create target-folder
  93                                   numlist
  94                                   new-mark
  95                                   already-mark
  96                                   seen-mark important-mark seen-list)
  97       ;; Copy from msgdb of target folder if it is unplugged.
  98       (let ((len (length numlist))
  99             (msgdb (elmo-folder-msgdb target-folder))
 100             overview number-alist mark-alist
 101             message-id seen gmark)
 102         (when (> len elmo-display-progress-threshold)
 103           (elmo-progress-set 'elmo-folder-msgdb-create
 104                              len "Creating msgdb..."))
 105         (unwind-protect
 106             (dolist (number numlist)
 107               (let ((entity (elmo-msgdb-overview-get-entity number msgdb)))
 108                 (when entity
 109                   (setq entity (elmo-msgdb-copy-overview-entity entity)
 110                         overview (elmo-msgdb-append-element overview entity)
 111                         message-id (elmo-msgdb-overview-entity-get-id entity)
 112                         number-alist (elmo-msgdb-number-add number-alist
 113                                                             number
 114                                                             message-id)
 115                         seen (member message-id seen-list))
 116                   (if (setq gmark (or (elmo-msgdb-global-mark-get message-id)
 117                                       (if (elmo-file-cache-exists-p message-id)
 118                                           (if seen
 119                                               nil
 120                                             already-mark)
 121                                         (if seen
 122                                             nil ;;seen-mark
 123                                           new-mark))))
 124                       (setq mark-alist
 125                             (elmo-msgdb-mark-append
 126                              mark-alist
 127                              number
 128                              gmark)))))
 129               (elmo-progress-notify 'elmo-folder-msgdb-create))
 130           (elmo-progress-clear 'elmo-folder-msgdb-create))
 131         (list overview number-alist mark-alist)))))
 132
 133 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
 134                                                unread &optional number)
 135   (elmo-folder-append-buffer
 136    (elmo-filter-folder-target-internal folder)
 137    unread number))
 138
 139 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
 140                                         number strategy
 141                                         &optional section outbuf unseen)
 142   (elmo-message-fetch
 143    (elmo-filter-folder-target-internal folder)
 144    number strategy section outbuf unseen))
 145
 146 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
 147                                                  numbers)
 148   (elmo-folder-delete-messages
 149    (elmo-filter-folder-target-internal folder) numbers))
 150
 151 (luna-define-method elmo-folder-list-messages-internal
 152   ((folder elmo-filter-folder) &optional nohide)
 153   (let ((target (elmo-filter-folder-target-internal folder)))
 154     (if (or (elmo-folder-plugged-p target)
 155             (not (elmo-folder-persistent-p folder)))
 156         ;; search target folder
 157         (elmo-folder-search
 158          target
 159          (elmo-filter-folder-condition-internal folder))
 160       ;; not available
 161       t)))
 162
 163 (defsubst elmo-filter-folder-list-unreads-internal (folder unread-marks
 164                                                            mark-alist)
 165   (let ((unreads (elmo-folder-list-unreads-internal
 166                   (elmo-filter-folder-target-internal folder)
 167                   unread-marks
 168                   (or mark-alist
 169                       (elmo-msgdb-get-mark-alist
 170                        (elmo-folder-msgdb folder))))))
 171     (unless (listp unreads)
 172       (setq unreads
 173             (delq nil
 174                   (mapcar
 175                    (function
 176                     (lambda (x)
 177                       (if (member (cadr x) unread-marks)
 178                           (car x))))
 179                    (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder))))))
 180     (elmo-list-filter
 181      (mapcar 'car (elmo-msgdb-get-number-alist
 182                    (elmo-folder-msgdb folder)))
 183      unreads)))
 184
 185 (luna-define-method elmo-folder-list-unreads-internal
 186   ((folder elmo-filter-folder)
 187    unread-marks &optional mark-alist)
 188   (elmo-filter-folder-list-unreads-internal folder unread-marks mark-alist))
 189
 190 (defsubst elmo-filter-folder-list-importants-internal (folder important-mark)
 191   (let ((importants (elmo-folder-list-importants-internal
 192                      (elmo-filter-folder-target-internal folder)
 193                      important-mark)))
 194     (if (listp importants)
 195         (elmo-list-filter
 196          (mapcar 'car (elmo-msgdb-get-number-alist
 197                        (elmo-folder-msgdb folder)))
 198          importants)
 199       t)))
 200
 201 (luna-define-method elmo-folder-list-importants-internal
 202   ((folder elmo-filter-folder)
 203    important-mark)
 204   (elmo-filter-folder-list-importants-internal folder important-mark))
 205
 206 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
 207                                                  &optional one-level)
 208   (let* ((target (elmo-filter-folder-target-internal folder))
 209          (prefix (and (string-match
 210                        (concat "^\\(.*\\)"
 211                                (regexp-quote
 212                                 (elmo-folder-name-internal
 213                                  target))
 214                                "$")
 215                        (elmo-folder-name-internal folder))
 216                       (match-string 1 (elmo-folder-name-internal
 217                                        folder)))))
 218     (elmo-mapcar-list-of-list
 219      (lambda (x) (concat prefix x))
 220      (elmo-folder-list-subfolders target one-level))))
 221
 222 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder)
 223                                               &optional numbers)
 224   (if (not (and (vectorp (elmo-filter-folder-condition-internal
 225                           folder))
 226                 (string-match "^last$"
 227                               (elmo-filter-key
 228                                (elmo-filter-folder-condition-internal
 229                                 folder)))))
 230       (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
 231                                         folder))))
 232     (luna-call-next-method)))
 233
 234 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
 235   (elmo-folder-status
 236    (elmo-filter-folder-target-internal folder)))
 237
 238 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
 239   (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
 240
 241 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
 242   (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
 243
 244 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
 245   (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
 246
 247 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
 248   (elmo-folder-create (elmo-filter-folder-target-internal folder)))
 249
 250 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
 251                                         condition &optional numbers)
 252   ;; search from messages in this folder
 253   (elmo-list-filter
 254    numbers
 255    (elmo-folder-search (elmo-filter-folder-target-internal folder)
 256                        condition
 257                        (elmo-folder-list-messages folder))))
 258
 259 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
 260                                               number)
 261   (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
 262                             number))
 263
 264 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
 265   (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
 266
 267 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
 268   (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
 269
 270 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
 271                                              plugged &optional add)
 272   (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
 273                            plugged add))
 274
 275 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
 276                                             number)
 277   (elmo-message-file-name (elmo-filter-folder-target-internal folder)
 278                           number))
 279
 280 (luna-define-method elmo-folder-mark-as-read ((folder elmo-filter-folder)
 281                                               numbers)
 282   (elmo-folder-mark-as-read (elmo-filter-folder-target-internal folder)
 283                             numbers))
 284
 285 (luna-define-method elmo-folder-unmark-read ((folder elmo-filter-folder)
 286                                               numbers)
 287   (elmo-folder-unmark-read (elmo-filter-folder-target-internal folder)
 288                            numbers))
 289
 290 (luna-define-method elmo-folder-mark-as-important ((folder elmo-filter-folder)
 291                                                    numbers)
 292   (elmo-folder-mark-as-important (elmo-filter-folder-target-internal folder)
 293                                  numbers))
 294
 295 (luna-define-method elmo-folder-unmark-important ((folder elmo-filter-folder)
 296                                                   numbers)
 297   (elmo-folder-unmark-important (elmo-filter-folder-target-internal folder)
 298                                 numbers))
 299
 300
 301 (require 'product)
 302 (product-provide (provide 'elmo-filter) (require 'elmo-version))
 303
 304 ;;; elmo-filter.el ends here