* elmo-filter.el (elmo-folder-list-subfolders): Defined.
[elisp/wanderlust.git] / 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-dir)))
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   (elmo-folder-msgdb-create (elmo-filter-folder-target-internal folder)
91                             numlist
92                             new-mark
93                             already-mark
94                             seen-mark important-mark seen-list))
95
96 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
97                                                unread &optional number)
98   (elmo-folder-append-buffer
99    (elmo-filter-folder-target-internal folder)
100    unread number))
101
102 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
103                                         number strategy
104                                         &optional section outbuf unseen)
105   (elmo-message-fetch
106    (elmo-filter-folder-target-internal folder)
107    number strategy section outbuf unseen))
108
109 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
110                                                  numbers)
111   (elmo-folder-delete-messages
112    (elmo-filter-folder-target-internal folder) numbers))
113
114 (luna-define-method elmo-folder-list-messages-internal
115   ((folder elmo-filter-folder) &optional nohide)
116   (elmo-folder-search (elmo-filter-folder-target-internal folder)
117                       (elmo-filter-folder-condition-internal folder)))
118
119 (defsubst elmo-filter-folder-list-unreads-internal (folder unread-marks
120                                                            mark-alist)
121   (let ((unreads (elmo-folder-list-unreads-internal
122                   (elmo-filter-folder-target-internal folder)
123                   unread-marks mark-alist)))
124     (unless (listp unreads)
125       (setq unreads
126             (delq nil
127                   (mapcar
128                    (function
129                     (lambda (x)
130                       (if (member (cadr x) unread-marks)
131                           (car x))))
132                    (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder))))))
133     (elmo-list-filter
134      (mapcar 'car (elmo-msgdb-get-number-alist
135                    (elmo-folder-msgdb folder)))
136      unreads)))
137
138 (luna-define-method elmo-folder-list-unreads-internal
139   ((folder elmo-filter-folder)
140    unread-marks &optional mark-alist)
141   (elmo-filter-folder-list-unreads-internal folder unread-marks mark-alist))
142
143 (defsubst elmo-filter-folder-list-importants-internal (folder important-mark)
144   (let ((importants (elmo-folder-list-importants-internal
145                      (elmo-filter-folder-target-internal folder)
146                      important-mark)))
147     (if (listp importants)
148         (elmo-list-filter
149          (mapcar 'car (elmo-msgdb-get-number-alist
150                        (elmo-folder-msgdb folder)))
151          importants)
152       t)))
153
154 (luna-define-method elmo-folder-list-importants-internal
155   ((folder elmo-filter-folder)
156    important-mark)
157   (elmo-filter-folder-list-importants-internal folder important-mark))
158
159 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
160                                                  &optional one-level)
161   (let* ((target (elmo-filter-folder-target-internal folder))
162          (prefix (and (string-match
163                        (concat "^\\(.*\\)"
164                                (regexp-quote
165                                 (elmo-folder-name-internal
166                                  target))
167                                "$")
168                        (elmo-folder-name-internal folder))
169                       (match-string 1 (elmo-folder-name-internal
170                                        folder)))))
171     (elmo-mapcar-list-of-list
172      (lambda (x) (concat prefix x))
173      (elmo-folder-list-subfolders target one-level))))
174
175 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder)
176                                               &optional numbers)
177   (if (not (and (vectorp (elmo-filter-folder-condition-internal
178                           folder))
179                 (string-match "^last$"
180                               (elmo-filter-key
181                                (elmo-filter-folder-condition-internal
182                                 folder)))))
183       (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
184                                         folder))))
185     (luna-call-next-method)))
186
187 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
188   (elmo-folder-status
189    (elmo-filter-folder-target-internal folder)))
190
191 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
192   (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
193
194 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
195   (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
196
197 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
198   (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
199
200 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
201   (elmo-folder-create (elmo-filter-folder-target-internal folder)))
202
203 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
204                                         condition &optional numbers)
205   ;; search from messages in this folder
206   (elmo-list-filter
207    numbers
208    (elmo-folder-search (elmo-filter-folder-target-internal folder)
209                        condition
210                        (elmo-folder-list-messages folder))))
211
212 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
213                                               number)
214   (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
215                             number))
216
217 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
218   (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
219
220 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
221   (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
222
223 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
224                                              plugged &optional add)
225   (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
226                            plugged add))
227
228 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
229                                             number)
230   (elmo-message-file-name (elmo-filter-folder-target-internal folder)
231                           number))
232
233 (luna-define-method elmo-folder-mark-as-read ((folder elmo-filter-folder)
234                                               numbers)
235   (elmo-folder-mark-as-read (elmo-filter-folder-target-internal folder)
236                             numbers))
237
238 (luna-define-method elmo-folder-unmark-read ((folder elmo-filter-folder)
239                                               numbers)
240   (elmo-folder-unmark-read (elmo-filter-folder-target-internal folder)
241                            numbers))
242
243 (luna-define-method elmo-folder-mark-as-important ((folder elmo-filter-folder)
244                                                    numbers)
245   (elmo-folder-mark-as-important (elmo-filter-folder-target-internal folder)
246                                  numbers))
247
248 (luna-define-method elmo-folder-unmark-important ((folder elmo-filter-folder)
249                                                   numbers)
250   (elmo-folder-unmark-important (elmo-filter-folder-target-internal folder)
251                                 numbers))
252
253
254 (require 'product)
255 (product-provide (provide 'elmo-filter) (require 'elmo-version))
256
257 ;;; elmo-filter.el ends here