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
150 ((folder elmo-filter-folder) entity &optional ignore-cache)
151 (elmo-find-fetch-strategy
152 (elmo-filter-folder-target-internal folder)
153 entity ignore-cache))
155 (luna-define-method elmo-folder-get-primitive-list ((folder
157 (elmo-folder-get-primitive-list (elmo-filter-folder-target-internal folder)))
159 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
161 (elmo-folder-contains-type
162 (elmo-filter-folder-target-internal folder)
165 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
166 &optional flag number)
167 (elmo-folder-append-buffer
168 (elmo-filter-folder-target-internal folder)
171 (luna-define-method elmo-message-fetch-bodystructure ((folder
174 (elmo-message-fetch-bodystructure
175 (elmo-filter-folder-target-internal folder)
178 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
180 &optional section outbuf unseen)
182 (elmo-filter-folder-target-internal folder)
183 number strategy section outbuf unseen))
185 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
187 (let ((flag-count (elmo-filter-folder-copy-flag-count
188 (elmo-filter-folder-flag-count-internal folder)))
189 (messages (copy-sequence
190 (elmo-filter-folder-number-list-internal folder)))
192 (elmo-folder-detach-messages folder numbers)
193 (unless (setq success
194 (elmo-folder-delete-messages
195 (elmo-filter-folder-target-internal folder) numbers))
196 (elmo-filter-folder-set-flag-count-internal folder flag-count)
197 (elmo-filter-folder-set-number-list-internal folder messages))
200 (luna-define-method elmo-folder-list-messages ((folder elmo-filter-folder)
201 &optional visible-only in-msgdb)
202 (let ((list (if in-msgdb
204 (elmo-folder-list-messages-internal folder visible-only)))
205 (killed-list (elmo-folder-killed-list-internal folder)))
208 (setq list (elmo-filter-folder-number-list folder)))
210 (elmo-living-messages list killed-list)
211 (if (and in-msgdb killed-list list)
212 (elmo-uniq-sorted-list
213 (sort (nconc (elmo-number-set-to-number-list killed-list) list) #'<)
217 (luna-define-method elmo-folder-list-messages-internal
218 ((folder elmo-filter-folder) &optional nohide)
219 (let ((target (elmo-filter-folder-target-internal folder)))
220 (if (or (elmo-folder-plugged-p target)
221 (not (elmo-folder-persistent-p folder)))
222 ;; search target folder
225 (elmo-filter-folder-condition-internal folder))
229 (luna-define-method elmo-folder-list-flagged ((folder elmo-filter-folder)
233 (elmo-folder-list-messages folder nil t)
234 (elmo-folder-list-flagged
235 (elmo-filter-folder-target-internal folder) flag in-msgdb)))
237 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
239 (let* ((target (elmo-filter-folder-target-internal folder))
240 (prefix (and (string-match
243 (elmo-folder-name-internal
246 (elmo-folder-name-internal folder))
247 (match-string 1 (elmo-folder-name-internal
249 (elmo-mapcar-list-of-list
250 (lambda (x) (concat prefix x))
251 (elmo-folder-list-subfolders target one-level))))
253 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder))
254 (let ((condition (elmo-filter-folder-condition-internal folder))
256 (if (vectorp condition)
258 ((and (string= (elmo-filter-key condition) "flag")
259 (or (string= (elmo-filter-value condition) "any")
260 (string= (elmo-filter-value condition) "digest")
261 (string= (elmo-filter-value condition) "unread")))
262 (setq diff (elmo-folder-diff (elmo-filter-folder-target-internal
264 (if (consp (cdr diff))
266 (list (car diff) (nth 1 diff) (nth 1 diff))
267 (cons (car diff) (car diff))))
268 ((string= "last" (elmo-filter-key condition))
269 (luna-call-next-method))
271 (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
273 (luna-call-next-method))))
275 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
277 (elmo-filter-folder-target-internal folder)))
279 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
280 (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
282 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
283 (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
285 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
286 (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
288 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
289 (elmo-folder-create (elmo-filter-folder-target-internal folder)))
291 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
292 condition &optional numbers)
293 ;; search from messages in this folder
294 (let ((result (elmo-folder-search
295 (elmo-filter-folder-target-internal folder)
297 (elmo-folder-list-messages folder))))
299 (elmo-list-filter numbers result)
302 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
304 (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
307 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
308 (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
310 (luna-define-method elmo-folder-local-p ((folder elmo-filter-folder))
311 (elmo-folder-local-p (elmo-filter-folder-target-internal folder)))
313 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
314 (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
316 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
317 plugged &optional add)
318 (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
321 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
323 (elmo-message-file-name (elmo-filter-folder-target-internal folder)
326 (luna-define-method elmo-message-flag-available-p ((folder
327 elmo-filter-folder) number
329 (elmo-message-flag-available-p
330 (elmo-filter-folder-target-internal folder)
333 (luna-define-method elmo-message-flags ((folder elmo-filter-folder) number)
334 (elmo-message-flags (elmo-filter-folder-target-internal folder)
337 (luna-define-method elmo-message-set-cached ((folder elmo-filter-folder)
339 (elmo-message-set-cached
340 (elmo-filter-folder-target-internal folder) number cached))
342 (luna-define-method elmo-message-number ((folder elmo-filter-folder)
344 (elmo-message-number (elmo-filter-folder-target-internal folder)
347 (luna-define-method elmo-message-entity ((folder elmo-filter-folder) key)
348 (elmo-message-entity (elmo-filter-folder-target-internal folder) key))
350 (luna-define-method elmo-message-entity-parent ((folder elmo-filter-folder)
352 (let ((parent (elmo-message-entity-parent
353 (elmo-filter-folder-target-internal folder)
355 (when (memq (elmo-message-entity-number parent)
356 (elmo-filter-folder-number-list folder))
359 (luna-define-method elmo-folder-flag-table ((folder elmo-filter-folder)
361 (elmo-folder-flag-table (elmo-filter-folder-target-internal folder)
364 (luna-define-method elmo-folder-close-flag-table ((folder elmo-filter-folder))
365 (elmo-folder-close-flag-table (elmo-filter-folder-target-internal folder)))
367 (luna-define-method elmo-folder-count-flags ((folder elmo-filter-folder))
368 (elmo-filter-folder-flag-count folder))
370 (luna-define-method elmo-folder-set-flag ((folder elmo-filter-folder)
374 (elmo-filter-folder-countup-message-flags folder numbers -1)
375 (elmo-folder-set-flag (elmo-filter-folder-target-internal folder)
376 numbers flag is-local)
377 (elmo-filter-folder-countup-message-flags folder numbers))
379 (luna-define-method elmo-folder-unset-flag ((folder elmo-filter-folder)
383 (elmo-filter-folder-countup-message-flags folder numbers -1)
384 (elmo-folder-unset-flag (elmo-filter-folder-target-internal folder)
385 numbers flag is-local)
386 (elmo-filter-folder-countup-message-flags folder numbers))
388 (luna-define-method elmo-message-folder ((folder elmo-filter-folder)
390 (elmo-message-folder (elmo-filter-folder-target-internal folder) number))
392 (luna-define-method elmo-folder-clear ((folder elmo-filter-folder)
393 &optional keep-killed)
395 (elmo-folder-set-killed-list-internal folder nil))
396 (elmo-filter-folder-set-number-list-internal folder nil)
397 (elmo-filter-folder-set-flag-count-internal folder nil))
399 (luna-define-method elmo-folder-synchronize ((folder elmo-filter-folder)
405 (let ((killed-list (elmo-folder-killed-list-internal folder))
408 (when (elmo-filter-folder-require-msgdb-internal folder)
409 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
414 (setq numbers (elmo-folder-list-messages folder (not disable-killed)))
416 (not (elmo-filter-folder-require-msgdb-internal folder)))
417 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
422 (elmo-list-filter mask numbers)
424 (when (and disable-killed ignore-msgdb)
425 (elmo-folder-set-killed-list-internal folder nil))
426 (elmo-filter-folder-set-number-list-internal folder numbers)
427 (elmo-filter-folder-set-flag-count-internal folder nil)
430 (luna-define-method elmo-folder-detach-messages ((folder elmo-filter-folder)
432 (elmo-filter-folder-countup-message-flags folder numbers -1)
433 (elmo-filter-folder-set-number-list-internal
435 (elmo-list-delete numbers (elmo-filter-folder-number-list folder) #'delq))
438 (luna-define-method elmo-folder-length ((folder elmo-filter-folder))
439 (length (elmo-filter-folder-number-list-internal folder)))
442 (product-provide (provide 'elmo-filter) (require 'elmo-version))
444 ;;; elmo-filter.el ends here