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 (luna-define-method elmo-folder-open :after ((folder elmo-filter-folder)
98 (elmo-filter-folder-number-list folder)
99 (elmo-filter-folder-flag-count folder)
100 (elmo-folder-msgdb (elmo-filter-folder-target-internal folder))))
102 (luna-define-method elmo-folder-open-internal ((folder elmo-filter-folder))
103 (elmo-folder-open-internal (elmo-filter-folder-target-internal folder)))
105 (luna-define-method elmo-folder-check ((folder elmo-filter-folder))
106 (when (elmo-filter-folder-require-msgdb-internal folder)
107 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder))))
109 (luna-define-method elmo-folder-close-internal ((folder elmo-filter-folder))
110 (elmo-folder-close-internal (elmo-filter-folder-target-internal folder)))
112 (luna-define-method elmo-folder-close :after ((folder elmo-filter-folder))
113 (elmo-filter-folder-set-number-list-internal folder nil)
114 (elmo-filter-folder-set-flag-count-internal folder nil)
115 (elmo-folder-set-msgdb-internal
116 (elmo-filter-folder-target-internal folder) nil))
118 (luna-define-method elmo-folder-commit ((folder elmo-filter-folder))
119 (elmo-folder-commit (elmo-filter-folder-target-internal folder))
120 (when (elmo-folder-persistent-p folder)
121 (elmo-folder-set-info-max-by-numdb
123 (elmo-folder-list-messages folder nil 'in-msgdb))
124 (elmo-msgdb-killed-list-save
125 (elmo-folder-msgdb-path folder)
126 (elmo-folder-killed-list-internal folder))
127 (elmo-filter-number-list-save
128 (elmo-folder-msgdb-path folder)
129 (elmo-filter-folder-number-list-internal folder))))
131 (luna-define-method elmo-folder-expand-msgdb-path ((folder
134 (elmo-replace-string-as-filename (elmo-folder-name-internal folder))
135 (expand-file-name "filter" elmo-msgdb-directory)))
137 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder
140 (elmo-folder-search-requires-msgdb-p
141 (elmo-filter-folder-target-internal folder) condition))
143 (luna-define-method elmo-folder-newsgroups ((folder elmo-filter-folder))
144 (elmo-folder-newsgroups (elmo-filter-folder-target-internal folder)))
146 (luna-define-method elmo-find-fetch-strategy
147 ((folder elmo-filter-folder) entity &optional ignore-cache)
148 (elmo-find-fetch-strategy
149 (elmo-filter-folder-target-internal folder)
150 entity ignore-cache))
152 (luna-define-method elmo-folder-get-primitive-list ((folder
154 (elmo-folder-get-primitive-list (elmo-filter-folder-target-internal folder)))
156 (luna-define-method elmo-folder-contains-type ((folder elmo-filter-folder)
158 (elmo-folder-contains-type
159 (elmo-filter-folder-target-internal folder)
162 (luna-define-method elmo-folder-append-buffer ((folder elmo-filter-folder)
163 &optional flag number)
164 (elmo-folder-append-buffer
165 (elmo-filter-folder-target-internal folder)
168 (luna-define-method elmo-message-fetch-bodystructure ((folder
171 (elmo-message-fetch-bodystructure
172 (elmo-filter-folder-target-internal folder)
175 (luna-define-method elmo-message-fetch ((folder elmo-filter-folder)
177 &optional section outbuf unseen)
179 (elmo-filter-folder-target-internal folder)
180 number strategy section outbuf unseen))
182 (luna-define-method elmo-folder-delete-messages ((folder elmo-filter-folder)
184 (and (elmo-folder-delete-messages
185 (elmo-filter-folder-target-internal folder) numbers)
186 (elmo-folder-detach-messages folder numbers)))
188 (luna-define-method elmo-folder-list-messages ((folder elmo-filter-folder)
189 &optional visible-only in-msgdb)
190 (let ((list (if in-msgdb
192 (elmo-folder-list-messages-internal folder visible-only)))
193 (killed-list (elmo-folder-killed-list-internal folder)))
196 (setq list (elmo-filter-folder-number-list folder)))
198 (elmo-living-messages list killed-list)
199 (if (and in-msgdb killed-list list)
200 (elmo-uniq-sorted-list
201 (sort (nconc (elmo-number-set-to-number-list killed-list) list) #'<)
205 (luna-define-method elmo-folder-list-messages-internal
206 ((folder elmo-filter-folder) &optional nohide)
207 (let ((target (elmo-filter-folder-target-internal folder)))
208 (if (or (elmo-folder-plugged-p target)
209 (not (elmo-folder-persistent-p folder)))
210 ;; search target folder
213 (elmo-filter-folder-condition-internal folder))
217 (luna-define-method elmo-folder-list-flagged ((folder elmo-filter-folder)
221 (elmo-folder-list-messages folder nil t)
222 (elmo-folder-list-flagged
223 (elmo-filter-folder-target-internal folder) flag in-msgdb)))
225 (luna-define-method elmo-folder-list-subfolders ((folder elmo-filter-folder)
227 (let* ((target (elmo-filter-folder-target-internal folder))
228 (prefix (and (string-match
231 (elmo-folder-name-internal
234 (elmo-folder-name-internal folder))
235 (match-string 1 (elmo-folder-name-internal
237 (elmo-mapcar-list-of-list
238 (lambda (x) (concat prefix x))
239 (elmo-folder-list-subfolders target one-level))))
241 (luna-define-method elmo-folder-diff :around ((folder elmo-filter-folder))
242 (let ((condition (elmo-filter-folder-condition-internal folder))
244 (if (vectorp condition)
246 ((and (string= (elmo-filter-key condition) "flag")
247 (or (string= (elmo-filter-value condition) "any")
248 (string= (elmo-filter-value condition) "digest")
249 (string= (elmo-filter-value condition) "unread")))
250 (setq diff (elmo-folder-diff (elmo-filter-folder-target-internal
252 (if (consp (cdr diff))
254 (list (car diff) (nth 1 diff) (nth 1 diff))
255 (cons (car diff) (car diff))))
256 ((string= "last" (elmo-filter-key condition))
257 (luna-call-next-method))
259 (cons nil (cdr (elmo-folder-diff (elmo-filter-folder-target-internal
261 (luna-call-next-method))))
263 (luna-define-method elmo-folder-status ((folder elmo-filter-folder))
265 (elmo-filter-folder-target-internal folder)))
267 (luna-define-method elmo-folder-exists-p ((folder elmo-filter-folder))
268 (elmo-folder-exists-p (elmo-filter-folder-target-internal folder)))
270 (luna-define-method elmo-folder-creatable-p ((folder elmo-filter-folder))
271 (elmo-folder-creatable-p (elmo-filter-folder-target-internal folder)))
273 (luna-define-method elmo-folder-writable-p ((folder elmo-filter-folder))
274 (elmo-folder-writable-p (elmo-filter-folder-target-internal folder)))
276 (luna-define-method elmo-folder-create ((folder elmo-filter-folder))
277 (elmo-folder-create (elmo-filter-folder-target-internal folder)))
279 (luna-define-method elmo-folder-search ((folder elmo-filter-folder)
280 condition &optional numbers)
281 ;; search from messages in this folder
282 (let ((result (elmo-folder-search
283 (elmo-filter-folder-target-internal folder)
285 (elmo-folder-list-messages folder))))
287 (elmo-list-filter numbers result)
290 (luna-define-method elmo-message-use-cache-p ((folder elmo-filter-folder)
292 (elmo-message-use-cache-p (elmo-filter-folder-target-internal folder)
295 (luna-define-method elmo-folder-message-file-p ((folder elmo-filter-folder))
296 (elmo-folder-message-file-p (elmo-filter-folder-target-internal folder)))
298 (luna-define-method elmo-folder-local-p ((folder elmo-filter-folder))
299 (elmo-folder-local-p (elmo-filter-folder-target-internal folder)))
301 (luna-define-method elmo-folder-plugged-p ((folder elmo-filter-folder))
302 (elmo-folder-plugged-p (elmo-filter-folder-target-internal folder)))
304 (luna-define-method elmo-folder-set-plugged ((folder elmo-filter-folder)
305 plugged &optional add)
306 (elmo-folder-set-plugged (elmo-filter-folder-target-internal folder)
309 (luna-define-method elmo-message-file-name ((folder elmo-filter-folder)
311 (elmo-message-file-name (elmo-filter-folder-target-internal folder)
314 (luna-define-method elmo-message-flag-available-p ((folder
315 elmo-filter-folder) number
317 (elmo-message-flag-available-p
318 (elmo-filter-folder-target-internal folder)
321 (luna-define-method elmo-message-flags ((folder elmo-filter-folder) number)
322 (elmo-message-flags (elmo-filter-folder-target-internal folder)
325 (luna-define-method elmo-message-set-cached ((folder elmo-filter-folder)
327 (elmo-message-set-cached
328 (elmo-filter-folder-target-internal folder) number cached))
330 (luna-define-method elmo-message-number ((folder elmo-filter-folder)
332 (elmo-message-number (elmo-filter-folder-target-internal folder)
335 (luna-define-method elmo-message-entity ((folder elmo-filter-folder) key)
336 (elmo-message-entity (elmo-filter-folder-target-internal folder) key))
338 (luna-define-method elmo-message-entity-parent ((folder elmo-filter-folder)
340 (let ((parent (elmo-message-entity-parent
341 (elmo-filter-folder-target-internal folder)
343 (when (memq (elmo-message-entity-number parent)
344 (elmo-filter-folder-number-list folder))
347 (luna-define-method elmo-folder-flag-table ((folder elmo-filter-folder)
349 (elmo-folder-flag-table (elmo-filter-folder-target-internal folder)
352 (luna-define-method elmo-folder-close-flag-table ((folder elmo-filter-folder))
353 (elmo-folder-close-flag-table (elmo-filter-folder-target-internal folder)))
355 (luna-define-method elmo-folder-count-flags ((folder elmo-filter-folder))
356 (elmo-filter-folder-flag-count folder))
358 (luna-define-method elmo-folder-set-flag ((folder elmo-filter-folder)
362 (elmo-filter-folder-countup-message-flags folder numbers -1)
363 (elmo-folder-set-flag (elmo-filter-folder-target-internal folder)
364 numbers flag is-local)
365 (elmo-filter-folder-countup-message-flags folder numbers))
367 (luna-define-method elmo-folder-unset-flag ((folder elmo-filter-folder)
371 (elmo-filter-folder-countup-message-flags folder numbers -1)
372 (elmo-folder-unset-flag (elmo-filter-folder-target-internal folder)
373 numbers flag is-local)
374 (elmo-filter-folder-countup-message-flags folder numbers))
376 (luna-define-method elmo-message-folder ((folder elmo-filter-folder)
378 (elmo-message-folder (elmo-filter-folder-target-internal folder) number))
380 (luna-define-method elmo-folder-clear ((folder elmo-filter-folder)
381 &optional keep-killed)
383 (elmo-folder-set-killed-list-internal folder nil))
384 (elmo-filter-folder-set-number-list-internal folder nil)
385 (elmo-filter-folder-set-flag-count-internal folder nil))
387 (luna-define-method elmo-folder-synchronize ((folder elmo-filter-folder)
393 (let ((killed-list (elmo-folder-killed-list-internal folder))
396 (when (elmo-filter-folder-require-msgdb-internal folder)
397 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
402 (setq numbers (elmo-folder-list-messages folder (not disable-killed)))
404 (not (elmo-filter-folder-require-msgdb-internal folder)))
405 (elmo-folder-synchronize (elmo-filter-folder-target-internal folder)
410 (elmo-list-filter mask numbers)
412 (when (and disable-killed ignore-msgdb)
413 (elmo-folder-set-killed-list-internal folder nil))
414 (elmo-filter-folder-set-number-list-internal folder numbers)
415 (elmo-filter-folder-set-flag-count-internal folder nil)
418 (luna-define-method elmo-folder-detach-messages ((folder elmo-filter-folder)
420 (elmo-filter-folder-countup-message-flags folder numbers -1)
421 (elmo-list-delete numbers (elmo-filter-folder-number-list folder) #'delq))
423 (luna-define-method elmo-folder-length ((folder elmo-filter-folder))
424 (length (elmo-filter-folder-number-list-internal folder)))
427 (product-provide (provide 'elmo-filter) (require 'elmo-version))
429 ;;; elmo-filter.el ends here