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.
35 (defvar elmo-filter-number-filename "number-list"
36 "File name for message number database.")
38 ;;; ELMO filter folder
40 (luna-define-class elmo-filter-folder (elmo-folder)
41 (condition target require-msgdb number-list flag-count))
42 (luna-define-internal-accessors 'elmo-filter-folder))
44 (luna-define-method elmo-folder-initialize ((folder elmo-filter-folder)
47 (setq pair (elmo-parse-search-condition name))
48 (elmo-filter-folder-set-condition-internal folder
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)))
62 (defun elmo-filter-number-list-load (dir)
64 (expand-file-name elmo-filter-number-filename dir)))
66 (defun elmo-filter-number-list-save (dir number-list)
68 (expand-file-name elmo-filter-number-filename dir)
71 (defun elmo-filter-folder-number-list (folder)
72 (or (elmo-filter-folder-number-list-internal folder)
73 (elmo-filter-folder-set-number-list-internal
75 (elmo-filter-number-list-load (elmo-folder-msgdb-path folder)))))
77 (defsubst elmo-filter-folder-countup-message-flags (folder numbers
79 (let ((flag-count (elmo-filter-folder-flag-count-internal folder))
82 (dolist (number numbers)
83 (dolist (flag (elmo-message-flags folder number))
84 (if (setq elem (assq flag flag-count))
85 (setcdr elem (+ (cdr elem) delta))
86 (setq flag-count (cons (cons flag delta) flag-count)))))
87 (elmo-filter-folder-set-flag-count-internal folder flag-count)))
89 (defun elmo-filter-folder-flag-count (folder)
90 (or (elmo-filter-folder-flag-count-internal folder)
91 (elmo-filter-folder-countup-message-flags
93 (elmo-folder-list-messages folder t t))))
95 (defun elmo-filter-folder-copy-flag-count (flag-counts)
96 (mapcar (lambda (pair) (cons (car pair) (cdr pair))) flag-counts))
98 (luna-define-method elmo-folder-open :after ((folder elmo-filter-folder)
101 (elmo-filter-folder-number-list folder)
102 (elmo-filter-folder-flag-count folder)
103 (elmo-folder-msgdb (elmo-filter-folder-target-internal folder))))
105 (luna-define-method elmo-folder-open-internal ((folder elmo-filter-folder))
106 (elmo-folder-open-internal (elmo-filter-folder-target-internal folder)))
108 (luna-define-method elmo-folder-check ((folder elmo-filter-folder))
109 (when (elmo-filter-folder-require-msgdb-internal folder)
110 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder))))
112 (luna-define-method elmo-folder-close-internal ((folder elmo-filter-folder))
113 (elmo-folder-close-internal (elmo-filter-folder-target-internal folder)))
115 (luna-define-method elmo-folder-close :after ((folder elmo-filter-folder))
116 (elmo-filter-folder-set-number-list-internal folder nil)
117 (elmo-filter-folder-set-flag-count-internal folder nil)
118 (elmo-folder-set-msgdb-internal
119 (elmo-filter-folder-target-internal folder) nil))
121 (luna-define-method elmo-folder-commit ((folder elmo-filter-folder))
122 (elmo-folder-commit (elmo-filter-folder-target-internal folder))
123 (when (elmo-folder-persistent-p folder)
124 (elmo-folder-set-info-max-by-numdb
126 (elmo-folder-list-messages folder nil 'in-msgdb))
127 (elmo-msgdb-killed-list-save
128 (elmo-folder-msgdb-path folder)
129 (elmo-folder-killed-list-internal folder))
130 (elmo-filter-number-list-save
131 (elmo-folder-msgdb-path folder)
132 (elmo-filter-folder-number-list-internal folder))))
134 (luna-define-method elmo-folder-expand-msgdb-path ((folder
137 (elmo-replace-string-as-filename (elmo-folder-name-internal folder))
138 (expand-file-name "filter" elmo-msgdb-directory)))
140 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder
143 (elmo-folder-search-requires-msgdb-p
144 (elmo-filter-folder-target-internal folder) condition))
146 (luna-define-method elmo-folder-newsgroups ((folder elmo-filter-folder))
147 (elmo-folder-newsgroups (elmo-filter-folder-target-internal folder)))
149 (luna-define-method elmo-find-fetch-strategy ((folder elmo-filter-folder)
154 (elmo-find-fetch-strategy
155 (elmo-filter-folder-target-internal folder)
156 number ignore-cache require-entireness))
158 (luna-define-method elmo-folder-get-primitive-list ((folder
160 (elmo-folder-get-primitive-list (elmo-filter-folder-target-internal folder)))
162 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
164 (elmo-folder-contains-type
165 (elmo-filter-folder-target-internal folder)
168 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
169 &optional flag number)
170 (elmo-folder-append-buffer
171 (elmo-filter-folder-target-internal folder)
174 (luna-define-method elmo-message-fetch-bodystructure ((folder
177 (elmo-message-fetch-bodystructure
178 (elmo-filter-folder-target-internal folder)
181 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
183 &optional section outbuf unseen)
185 (elmo-filter-folder-countup-message-flags folder (list number) -1))
186 (when (elmo-message-fetch (elmo-filter-folder-target-internal folder)
187 number strategy section outbuf unseen)
189 (elmo-filter-folder-countup-message-flags folder (list number))
190 (elmo-folder-notify-event folder 'flag-changed (list number)))
193 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
195 (let ((flag-count (elmo-filter-folder-copy-flag-count
196 (elmo-filter-folder-flag-count-internal folder)))
197 (messages (copy-sequence
198 (elmo-filter-folder-number-list-internal folder)))
200 (elmo-folder-detach-messages folder numbers)
201 (unless (setq success
202 (elmo-folder-delete-messages
203 (elmo-filter-folder-target-internal folder) numbers))
204 (elmo-filter-folder-set-flag-count-internal folder flag-count)
205 (elmo-filter-folder-set-number-list-internal folder messages))
208 (luna-define-method elmo-folder-list-messages ((folder elmo-filter-folder)
209 &optional visible-only in-msgdb)
210 (let ((list (if in-msgdb
212 (elmo-folder-list-messages-internal folder visible-only)))
213 (killed-list (elmo-folder-killed-list-internal folder)))
216 (setq list (elmo-filter-folder-number-list folder)))
218 (elmo-living-messages list killed-list)
219 (if (and in-msgdb killed-list list)
220 (elmo-uniq-sorted-list
221 (sort (nconc (elmo-number-set-to-number-list killed-list) list) #'<)
225 (luna-define-method elmo-folder-list-messages-internal
226 ((folder elmo-filter-folder) &optional nohide)
227 (let ((target (elmo-filter-folder-target-internal folder)))
228 (if (or (elmo-folder-plugged-p target)
229 (not (elmo-folder-persistent-p folder)))
230 ;; search target folder
233 (elmo-filter-folder-condition-internal folder))
237 (luna-define-method elmo-folder-list-flagged ((folder elmo-filter-folder)
241 (elmo-folder-list-messages folder nil t)
242 (elmo-folder-list-flagged
243 (elmo-filter-folder-target-internal folder) flag in-msgdb)))
245 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
247 (let* ((target (elmo-filter-folder-target-internal folder))
248 (prefix (and (string-match
251 (elmo-folder-name-internal
254 (elmo-folder-name-internal folder))
255 (match-string 1 (elmo-folder-name-internal
257 (elmo-mapcar-list-of-list
258 (lambda (x) (concat prefix x))
259 (elmo-folder-list-subfolders target one-level))))
261 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder))
262 (let ((condition (elmo-filter-folder-condition-internal folder))
264 (if (vectorp condition)
266 ((and (string= (elmo-filter-key condition) "flag")
267 (or (string= (elmo-filter-value condition) "any")
268 (string= (elmo-filter-value condition) "digest")
269 (string= (elmo-filter-value condition) "unread")))
270 (setq diff (elmo-folder-diff (elmo-filter-folder-target-internal
272 (if (consp (cdr diff))
274 (list (car diff) (nth 1 diff) (nth 1 diff))
275 (cons (car diff) (car diff))))
276 ((string= "last" (elmo-filter-key condition))
277 (luna-call-next-method))
279 (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
281 (luna-call-next-method))))
283 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
285 (elmo-filter-folder-target-internal folder)))
287 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
288 (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
290 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
291 (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
293 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
294 (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
296 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
297 (elmo-folder-create (elmo-filter-folder-target-internal folder)))
299 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
300 condition &optional numbers)
301 ;; search from messages in this folder
302 (let ((result (elmo-folder-search
303 (elmo-filter-folder-target-internal folder)
305 (elmo-folder-list-messages folder))))
307 (elmo-list-filter numbers result)
310 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
312 (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
315 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
316 (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
318 (luna-define-method elmo-folder-local-p ((folder elmo-filter-folder))
319 (elmo-folder-local-p (elmo-filter-folder-target-internal folder)))
321 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
322 (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
324 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
325 plugged &optional add)
326 (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
329 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
331 (elmo-message-file-name (elmo-filter-folder-target-internal folder)
334 (luna-define-method elmo-message-flag-available-p ((folder
335 elmo-filter-folder) number
337 (elmo-message-flag-available-p
338 (elmo-filter-folder-target-internal folder)
341 (luna-define-method elmo-message-flags ((folder elmo-filter-folder) number)
342 (elmo-message-flags (elmo-filter-folder-target-internal folder)
345 (luna-define-method elmo-message-set-cached ((folder elmo-filter-folder)
347 (elmo-message-set-cached
348 (elmo-filter-folder-target-internal folder) number cached))
350 (luna-define-method elmo-message-number ((folder elmo-filter-folder)
352 (elmo-message-number (elmo-filter-folder-target-internal folder)
355 (luna-define-method elmo-message-entity ((folder elmo-filter-folder) key)
356 (elmo-message-entity (elmo-filter-folder-target-internal folder) key))
358 (luna-define-method elmo-message-entity-parent ((folder elmo-filter-folder)
360 (let ((parent (elmo-message-entity-parent
361 (elmo-filter-folder-target-internal folder)
363 (when (memq (elmo-message-entity-number parent)
364 (elmo-filter-folder-number-list folder))
367 (luna-define-method elmo-folder-flag-table ((folder elmo-filter-folder)
369 (elmo-folder-flag-table (elmo-filter-folder-target-internal folder)
372 (luna-define-method elmo-folder-close-flag-table ((folder elmo-filter-folder))
373 (elmo-folder-close-flag-table (elmo-filter-folder-target-internal folder)))
375 (luna-define-method elmo-folder-count-flags ((folder elmo-filter-folder))
376 (elmo-filter-folder-flag-count folder))
378 (luna-define-method elmo-folder-set-flag ((folder elmo-filter-folder)
382 (elmo-filter-folder-countup-message-flags folder numbers -1)
383 (elmo-folder-set-flag (elmo-filter-folder-target-internal folder)
384 numbers flag is-local)
385 (elmo-filter-folder-countup-message-flags folder numbers)
386 (elmo-folder-notify-event folder 'flag-changed numbers))
388 (luna-define-method elmo-folder-unset-flag ((folder elmo-filter-folder)
392 (elmo-filter-folder-countup-message-flags folder numbers -1)
393 (elmo-folder-unset-flag (elmo-filter-folder-target-internal folder)
394 numbers flag is-local)
395 (elmo-filter-folder-countup-message-flags folder numbers)
396 (elmo-folder-notify-event folder 'flag-changed numbers))
398 (luna-define-method elmo-message-folder ((folder elmo-filter-folder)
400 (elmo-message-folder (elmo-filter-folder-target-internal folder) number))
402 (luna-define-method elmo-message-field ((folder elmo-filter-folder)
405 (elmo-filter-folder-target-internal folder) number field))
407 (luna-define-method elmo-message-set-field ((folder elmo-filter-folder)
409 (elmo-message-set-field
410 (elmo-filter-folder-target-internal folder) number field value))
412 (luna-define-method elmo-folder-clear ((folder elmo-filter-folder)
413 &optional keep-killed)
415 (elmo-folder-set-killed-list-internal folder nil))
416 (elmo-filter-folder-set-number-list-internal folder nil)
417 (elmo-filter-folder-set-flag-count-internal folder nil))
419 (luna-define-method elmo-folder-synchronize ((folder elmo-filter-folder)
425 (let ((killed-list (elmo-folder-killed-list-internal folder))
428 (when (elmo-filter-folder-require-msgdb-internal folder)
429 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
434 (setq numbers (elmo-folder-list-messages folder (not disable-killed)))
436 (not (elmo-filter-folder-require-msgdb-internal folder)))
437 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
442 (elmo-list-filter mask numbers)
444 (when (and disable-killed ignore-msgdb)
445 (elmo-folder-set-killed-list-internal folder nil))
446 (elmo-filter-folder-set-number-list-internal folder numbers)
447 (elmo-filter-folder-set-flag-count-internal folder nil)
450 (luna-define-method elmo-folder-detach-messages ((folder elmo-filter-folder)
452 (elmo-filter-folder-countup-message-flags folder numbers -1)
453 (elmo-filter-folder-set-number-list-internal
455 (elmo-list-delete numbers (elmo-filter-folder-number-list folder) #'delq))
458 (luna-define-method elmo-folder-length ((folder elmo-filter-folder))
459 (length (elmo-filter-folder-number-list-internal folder)))
462 (product-provide (provide 'elmo-filter) (require 'elmo-version))
464 ;;; elmo-filter.el ends here