1 ;;; elmo-filter.el --- Filtered Folder Interface for ELMO.
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
6 ;; Hiroya Murata <lapis-lazuli@pop06.odn.ne.jp>
7 ;; Keywords: mail, net news
9 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
11 ;; This program is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; This program is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
33 (require 'elmo-signal)
36 (defvar elmo-filter-number-filename "number-list"
37 "File name for message number database.")
39 ;;; ELMO filter folder
41 (luna-define-class elmo-filter-folder (elmo-folder)
42 (condition target require-msgdb number-list flag-count))
43 (luna-define-internal-accessors 'elmo-filter-folder))
45 (luna-define-method elmo-folder-initialize ((folder elmo-filter-folder)
48 (setq pair (elmo-parse-search-condition name))
49 (elmo-filter-folder-set-condition-internal folder (car pair))
50 (if (string-match "^ */\\(.*\\)$" (cdr pair))
51 (elmo-filter-folder-set-target-internal
53 (elmo-make-folder (elmo-match-string 1 (cdr pair))))
54 (error "Folder syntax error `%s'" (elmo-folder-name-internal folder)))
55 (elmo-filter-folder-set-require-msgdb-internal
57 (elmo-folder-search-requires-msgdb-p
58 (elmo-filter-folder-target-internal folder)
59 (elmo-filter-folder-condition-internal folder)))
60 (elmo-filter-connect-signals
62 (elmo-filter-folder-target-internal folder))
65 (defun elmo-filter-connect-signals (folder target)
67 target 'flag-changing folder
68 (elmo-define-signal-handler (folder target number old-flags new-flags)
69 (elmo-filter-add-flag-count folder number old-flags -1)
70 (elmo-filter-add-flag-count folder number new-flags)
71 (elmo-emit-signal 'flag-changing folder number old-flags new-flags))
72 (elmo-define-signal-filter (folder target number)
73 (memq number (elmo-folder-list-messages folder nil t))))
75 target 'flag-changed folder
76 (elmo-define-signal-handler (folder target numbers)
77 (let ((filterd (elmo-list-filter
78 (elmo-folder-list-messages folder nil t)
81 (elmo-emit-signal 'flag-changed folder filterd)))))
83 target 'cache-changed folder
84 (elmo-define-signal-handler (folder target number)
85 (elmo-emit-signal 'cache-changed folder number))
86 (elmo-define-signal-filter (folder target number)
87 (memq number (elmo-folder-list-messages folder nil t)))))
89 (defun elmo-filter-number-list-load (dir)
91 (expand-file-name elmo-filter-number-filename dir)))
93 (defun elmo-filter-number-list-save (dir number-list)
95 (expand-file-name elmo-filter-number-filename dir)
98 (defun elmo-filter-folder-number-list (folder)
99 (or (elmo-filter-folder-number-list-internal folder)
100 (elmo-filter-folder-set-number-list-internal
102 (elmo-filter-number-list-load (elmo-folder-msgdb-path folder)))))
104 (defsubst elmo-filter-folder-countup-message-flags (folder numbers
106 (let ((flag-count (elmo-filter-folder-flag-count-internal folder))
109 (dolist (number numbers)
110 (dolist (flag (elmo-message-flags folder number))
111 (if (setq elem (assq flag flag-count))
112 (setcdr elem (+ (cdr elem) delta))
113 (setq flag-count (cons (cons flag delta) flag-count)))))
114 (elmo-filter-folder-set-flag-count-internal folder flag-count)))
116 (defun elmo-filter-add-flag-count (folder number flags &optional delta)
117 (let ((flag-count (elmo-filter-folder-flag-count-internal folder))
121 (if (setq elem (assq flag flag-count))
122 (setcdr elem (+ (cdr elem) delta))
123 (setq flag-count (cons (cons flag delta) flag-count))))
124 (elmo-filter-folder-set-flag-count-internal folder flag-count)))
126 (defun elmo-filter-folder-flag-count (folder)
127 (or (elmo-filter-folder-flag-count-internal folder)
128 (elmo-filter-folder-countup-message-flags
130 (elmo-folder-list-messages folder t t))))
132 (defun elmo-filter-folder-copy-flag-count (flag-counts)
133 (mapcar (lambda (pair) (cons (car pair) (cdr pair))) flag-counts))
135 (luna-define-method elmo-folder-open :after ((folder elmo-filter-folder)
136 &optional load-msgdb)
138 (elmo-filter-folder-number-list folder)
139 (elmo-filter-folder-flag-count folder)
140 (elmo-folder-msgdb (elmo-filter-folder-target-internal folder))))
142 (luna-define-method elmo-folder-open-internal ((folder elmo-filter-folder))
143 (elmo-folder-open-internal (elmo-filter-folder-target-internal folder)))
145 (luna-define-method elmo-folder-check ((folder elmo-filter-folder))
146 (when (elmo-filter-folder-require-msgdb-internal folder)
147 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder))))
149 (luna-define-method elmo-folder-close-internal ((folder elmo-filter-folder))
150 (elmo-folder-close-internal (elmo-filter-folder-target-internal folder)))
152 (luna-define-method elmo-folder-close :after ((folder elmo-filter-folder))
153 (elmo-filter-folder-set-number-list-internal folder nil)
154 (elmo-filter-folder-set-flag-count-internal folder nil)
155 (elmo-folder-set-msgdb-internal
156 (elmo-filter-folder-target-internal folder) nil))
158 (luna-define-method elmo-folder-commit ((folder elmo-filter-folder))
159 (elmo-folder-commit (elmo-filter-folder-target-internal folder))
160 (when (elmo-folder-persistent-p folder)
161 (elmo-folder-set-info-max-by-numdb
163 (elmo-folder-list-messages folder nil 'in-msgdb))
164 (elmo-msgdb-killed-list-save
165 (elmo-folder-msgdb-path folder)
166 (elmo-folder-killed-list-internal folder))
167 (elmo-filter-number-list-save
168 (elmo-folder-msgdb-path folder)
169 (elmo-filter-folder-number-list-internal folder))))
171 (luna-define-method elmo-folder-expand-msgdb-path ((folder
174 (elmo-replace-string-as-filename (elmo-folder-name-internal folder))
175 (expand-file-name "filter" elmo-msgdb-directory)))
177 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder
180 (elmo-folder-search-requires-msgdb-p
181 (elmo-filter-folder-target-internal folder) condition))
183 (luna-define-method elmo-folder-newsgroups ((folder elmo-filter-folder))
184 (elmo-folder-newsgroups (elmo-filter-folder-target-internal folder)))
186 (luna-define-method elmo-find-fetch-strategy ((folder elmo-filter-folder)
191 (elmo-find-fetch-strategy
192 (elmo-filter-folder-target-internal folder)
193 number ignore-cache require-entireness))
195 (luna-define-method elmo-folder-get-primitive-list ((folder
197 (elmo-folder-get-primitive-list (elmo-filter-folder-target-internal folder)))
199 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
201 (elmo-folder-contains-type
202 (elmo-filter-folder-target-internal folder)
205 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
206 &optional flag number)
207 (elmo-folder-append-buffer
208 (elmo-filter-folder-target-internal folder)
211 (luna-define-method elmo-message-fetch-bodystructure ((folder
214 (elmo-message-fetch-bodystructure
215 (elmo-filter-folder-target-internal folder)
218 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
220 &optional unseen section)
221 (elmo-message-fetch (elmo-filter-folder-target-internal folder)
222 number strategy unseen section))
224 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
226 (let ((flag-count (elmo-filter-folder-copy-flag-count
227 (elmo-filter-folder-flag-count-internal folder)))
228 (messages (copy-sequence
229 (elmo-filter-folder-number-list-internal folder)))
231 (elmo-folder-detach-messages folder numbers)
232 (unless (setq success
233 (elmo-folder-delete-messages
234 (elmo-filter-folder-target-internal folder) numbers))
235 (elmo-filter-folder-set-flag-count-internal folder flag-count)
236 (elmo-filter-folder-set-number-list-internal folder messages))
239 (luna-define-method elmo-folder-list-messages ((folder elmo-filter-folder)
240 &optional visible-only in-msgdb)
241 (let ((list (if in-msgdb
243 (elmo-folder-list-messages-internal folder visible-only)))
244 (killed-list (elmo-folder-killed-list-internal folder)))
247 (setq list (elmo-filter-folder-number-list folder)))
249 (elmo-living-messages list killed-list)
250 (if (and in-msgdb killed-list list)
251 (elmo-uniq-sorted-list
252 (sort (nconc (elmo-number-set-to-number-list killed-list) list) #'<)
256 (luna-define-method elmo-folder-list-messages-internal
257 ((folder elmo-filter-folder) &optional nohide)
258 (let ((target (elmo-filter-folder-target-internal folder)))
259 (if (or (elmo-folder-plugged-p target)
260 (not (elmo-folder-persistent-p folder)))
261 ;; search target folder
264 (elmo-filter-folder-condition-internal folder))
268 (luna-define-method elmo-folder-list-flagged ((folder elmo-filter-folder)
272 (elmo-folder-list-messages folder nil t)
273 (elmo-folder-list-flagged
274 (elmo-filter-folder-target-internal folder) flag in-msgdb)))
276 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
278 (let* ((target (elmo-filter-folder-target-internal folder))
279 (prefix (and (string-match
282 (elmo-folder-name-internal
285 (elmo-folder-name-internal folder))
286 (match-string 1 (elmo-folder-name-internal
288 (elmo-mapcar-list-of-list
289 (lambda (x) (concat prefix x))
290 (elmo-folder-list-subfolders target one-level))))
292 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder))
293 (let ((condition (elmo-filter-folder-condition-internal folder))
295 (if (vectorp condition)
297 ((and (string= (elmo-filter-key condition) "flag")
298 (or (string= (elmo-filter-value condition) "any")
299 (string= (elmo-filter-value condition) "digest")
300 (string= (elmo-filter-value condition) "unread")))
301 (setq diff (elmo-folder-diff (elmo-filter-folder-target-internal
303 (if (consp (cdr diff))
305 (list (car diff) (nth 1 diff) (nth 1 diff))
306 (cons (car diff) (car diff))))
307 ((string= "last" (elmo-filter-key condition))
308 (luna-call-next-method))
310 (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
312 (luna-call-next-method))))
314 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
316 (elmo-filter-folder-target-internal folder)))
318 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
319 (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
321 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
322 (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
324 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
325 (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
327 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
328 (elmo-folder-create (elmo-filter-folder-target-internal folder)))
330 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
331 condition &optional numbers)
332 ;; search from messages in this folder
333 (let ((result (elmo-folder-search
334 (elmo-filter-folder-target-internal folder)
336 (elmo-folder-list-messages folder))))
338 (elmo-list-filter numbers result)
341 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
343 (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
346 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
347 (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
349 (luna-define-method elmo-folder-local-p ((folder elmo-filter-folder))
350 (elmo-folder-local-p (elmo-filter-folder-target-internal folder)))
352 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
353 (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
355 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
356 plugged &optional add)
357 (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
360 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
362 (elmo-message-file-name (elmo-filter-folder-target-internal folder)
365 (luna-define-method elmo-message-flag-available-p ((folder
366 elmo-filter-folder) number
368 (elmo-message-flag-available-p
369 (elmo-filter-folder-target-internal folder)
372 (luna-define-method elmo-message-flags ((folder elmo-filter-folder) number)
373 (elmo-message-flags (elmo-filter-folder-target-internal folder)
376 (luna-define-method elmo-message-set-cached ((folder elmo-filter-folder)
378 (elmo-message-set-cached
379 (elmo-filter-folder-target-internal folder) number cached))
381 (luna-define-method elmo-message-number ((folder elmo-filter-folder)
383 (elmo-message-number (elmo-filter-folder-target-internal folder)
386 (luna-define-method elmo-message-entity ((folder elmo-filter-folder) key)
387 (elmo-message-entity (elmo-filter-folder-target-internal folder) key))
389 (luna-define-method elmo-message-entity-parent ((folder elmo-filter-folder)
391 (let ((parent (elmo-message-entity-parent
392 (elmo-filter-folder-target-internal folder)
394 (when (memq (elmo-message-entity-number parent)
395 (elmo-filter-folder-number-list folder))
398 (luna-define-method elmo-folder-flag-table ((folder elmo-filter-folder)
400 (elmo-folder-flag-table (elmo-filter-folder-target-internal folder)
403 (luna-define-method elmo-folder-close-flag-table ((folder elmo-filter-folder))
404 (elmo-folder-close-flag-table (elmo-filter-folder-target-internal folder)))
406 (luna-define-method elmo-folder-count-flags ((folder elmo-filter-folder))
407 (elmo-filter-folder-flag-count folder))
409 (luna-define-method elmo-folder-set-flag ((folder elmo-filter-folder)
413 (elmo-folder-set-flag (elmo-filter-folder-target-internal folder)
414 numbers flag is-local))
416 (luna-define-method elmo-folder-unset-flag ((folder elmo-filter-folder)
420 (elmo-folder-unset-flag (elmo-filter-folder-target-internal folder)
421 numbers flag is-local))
423 (luna-define-method elmo-message-folder ((folder elmo-filter-folder)
425 (elmo-message-folder (elmo-filter-folder-target-internal folder) number))
427 (luna-define-method elmo-message-field ((folder elmo-filter-folder)
430 (elmo-filter-folder-target-internal folder) number field))
432 (luna-define-method elmo-message-set-field ((folder elmo-filter-folder)
434 (elmo-message-set-field
435 (elmo-filter-folder-target-internal folder) number field value))
437 (luna-define-method elmo-folder-clear ((folder elmo-filter-folder)
438 &optional keep-killed)
440 (elmo-folder-set-killed-list-internal folder nil))
441 (elmo-filter-folder-set-number-list-internal folder nil)
442 (elmo-filter-folder-set-flag-count-internal folder nil))
444 (luna-define-method elmo-folder-synchronize ((folder elmo-filter-folder)
450 (let ((killed-list (elmo-folder-killed-list-internal folder))
453 (when (elmo-filter-folder-require-msgdb-internal folder)
454 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
459 (setq numbers (elmo-folder-list-messages folder (not disable-killed)))
461 (not (elmo-filter-folder-require-msgdb-internal folder)))
462 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
467 (elmo-list-filter mask numbers)
469 (when (and disable-killed ignore-msgdb)
470 (elmo-folder-set-killed-list-internal folder nil))
471 (elmo-filter-folder-set-number-list-internal folder numbers)
472 (elmo-filter-folder-set-flag-count-internal folder nil)
475 (luna-define-method elmo-folder-detach-messages ((folder elmo-filter-folder)
477 (elmo-filter-folder-countup-message-flags folder numbers -1)
478 (elmo-filter-folder-set-number-list-internal
480 (elmo-list-delete numbers (elmo-filter-folder-number-list folder) #'delq))
483 (luna-define-method elmo-folder-length ((folder elmo-filter-folder))
484 (length (elmo-filter-folder-number-list-internal folder)))
487 (product-provide (provide 'elmo-filter) (require 'elmo-version))
489 ;;; elmo-filter.el ends here