* elmo-filter.el (elmo-folder-set-message-modified): Define.
[elisp/wanderlust.git] / elmo / elmo-multi.el
1 ;;; elmo-multi.el --- Multiple 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
32 (require 'elmo)
33 (require 'luna)
34
35 (defvar elmo-multi-divide-number 100000
36   "*Multi divider number.")
37
38 ;;; ELMO Multi folder
39 (eval-and-compile
40   (luna-define-class elmo-multi-folder (elmo-folder)
41                      (children divide-number))
42   (luna-define-internal-accessors 'elmo-multi-folder))
43
44 (defmacro elmo-multi-real-folder-number (folder number)
45   "Returns a cons cell of real FOLDER and NUMBER."
46   (` (cons (nth (- 
47                  (/ (, number)
48                     (elmo-multi-folder-divide-number-internal (, folder)))
49                  1) (elmo-multi-folder-children-internal (, folder)))
50            (% (, number) (elmo-multi-folder-divide-number-internal
51                           (, folder))))))
52
53 (luna-define-method elmo-folder-initialize ((folder
54                                              elmo-multi-folder)
55                                             name)
56   (while (> (length (car (setq name (elmo-parse-token name ",")))) 0)
57     (elmo-multi-folder-set-children-internal
58      folder
59      (nconc (elmo-multi-folder-children-internal
60              folder)
61             (list (elmo-make-folder (car name)))))
62     (setq name (cdr name))
63     (when (and (> (length name) 0)
64                (eq (aref name 0) ?,))
65       (setq name (substring name 1))))
66   (elmo-multi-folder-set-divide-number-internal
67    folder
68    elmo-multi-divide-number)
69   folder)
70
71 (luna-define-method elmo-folder-open-internal ((folder elmo-multi-folder))
72   (dolist (fld (elmo-multi-folder-children-internal folder))
73     (elmo-folder-open-internal fld)))
74
75 (luna-define-method elmo-folder-check ((folder elmo-multi-folder))
76   (dolist (fld (elmo-multi-folder-children-internal folder))
77     (elmo-folder-check fld)))
78
79 (luna-define-method elmo-folder-close-internal ((folder elmo-multi-folder))
80   (dolist (fld (elmo-multi-folder-children-internal folder))
81     (elmo-folder-close-internal fld)))
82
83 (luna-define-method elmo-folder-close :after ((folder elmo-multi-folder))
84   (dolist (fld (elmo-multi-folder-children-internal folder))
85     (elmo-folder-set-msgdb-internal fld nil)))
86
87 (luna-define-method elmo-folder-synchronize ((folder elmo-multi-folder)
88                                              &optional
89                                              disable-killed
90                                              ignore-msgdb
91                                              no-check)
92   (dolist (fld (elmo-multi-folder-children-internal folder))
93     (elmo-folder-synchronize fld disable-killed ignore-msgdb no-check))
94   0)
95
96 (luna-define-method elmo-folder-expand-msgdb-path ((folder
97                                                     elmo-multi-folder))
98   (expand-file-name (elmo-replace-string-as-filename
99                      (elmo-folder-name-internal folder))
100                     (expand-file-name "multi"
101                                       elmo-msgdb-directory)))
102
103 (luna-define-method elmo-folder-newsgroups ((folder elmo-multi-folder))
104   (delq nil
105         (elmo-flatten
106          (mapcar
107           'elmo-folder-newsgroups
108           (elmo-flatten
109            (mapcar
110             'elmo-folder-get-primitive-list
111             (elmo-multi-folder-children-internal folder)))))))
112
113 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-multi-folder))
114   (elmo-flatten
115    (mapcar
116     'elmo-folder-get-primitive-list
117     (elmo-multi-folder-children-internal folder))))
118
119 (luna-define-method elmo-folder-contains-type ((folder elmo-multi-folder) type)
120   (let ((children (elmo-multi-folder-children-internal folder))
121         match)
122     (while children
123       (when (elmo-folder-contains-type (car children) type)
124         (setq match t)
125         (setq children nil))
126       (setq children (cdr children)))
127     match))
128
129 (luna-define-method elmo-message-folder ((folder elmo-multi-folder)
130                                          number)
131   (nth (- (/ number (elmo-multi-folder-divide-number-internal folder)) 1)
132        (elmo-multi-folder-children-internal folder)))
133
134 (luna-define-method elmo-message-set-cached ((folder elmo-multi-folder)
135                                              number cached)
136   (let ((pair (elmo-multi-real-folder-number folder number)))
137     (elmo-message-set-cached (car pair) (cdr pair) cached)))
138
139 (luna-define-method elmo-find-fetch-strategy
140   ((folder elmo-multi-folder) entity &optional ignore-cache)
141   (let ((pair (elmo-multi-real-folder-number
142                folder
143                (elmo-message-entity-number entity))))
144     (elmo-find-fetch-strategy
145      (car pair)
146      (elmo-message-entity (car pair) (cdr pair)) ignore-cache)))
147
148 (luna-define-method elmo-message-entity ((folder elmo-multi-folder) key)
149   (cond
150    ((numberp key)
151     (let* ((pair (elmo-multi-real-folder-number folder key))
152            (entity (elmo-message-entity (car pair) (cdr pair))))
153       (when entity
154         (elmo-message-entity-set-number (elmo-message-copy-entity entity)
155                                         key))))
156    ((stringp key)
157     (let ((children (elmo-multi-folder-children-internal folder))
158           (cur-number 0)
159           match)
160       (while children
161         (setq cur-number (+ cur-number 1))
162         (when (setq match (elmo-message-entity (car children) key))
163           (setq match (elmo-message-copy-entity match))
164           (elmo-message-entity-set-number
165            match
166            (+ (* (elmo-multi-folder-divide-number-internal folder)
167                  cur-number)
168               (elmo-message-entity-number match)))
169           (setq children nil))
170         (setq children (cdr children)))
171       match))))
172
173 (luna-define-method elmo-message-field ((folder elmo-multi-folder)
174                                         number field)
175   (let ((pair (elmo-multi-real-folder-number folder number)))
176     (elmo-message-field (car pair) (cdr pair) field)))
177
178 (luna-define-method elmo-message-mark ((folder elmo-multi-folder) number)
179   (let ((pair (elmo-multi-real-folder-number folder number)))
180     (elmo-message-mark (car pair) (cdr pair))))
181
182 (defun elmo-multi-split-numbers (folder numlist &optional as-is)
183   (let ((numbers (sort numlist '<))
184         (divider (elmo-multi-folder-divide-number-internal folder))
185         (cur-number 0)
186         one-list numbers-list)
187     (while numbers
188       (setq cur-number (+ cur-number 1))
189       (setq one-list nil)
190       (while (and numbers
191                   (eq 0
192                       (/ (- (car numbers)
193                             (* divider cur-number))
194                          divider)))
195         (setq one-list (nconc
196                         one-list
197                         (list
198                          (if as-is
199                              (car numbers)
200                            (% (car numbers)
201                               (* divider cur-number))))))
202         (setq numbers (cdr numbers)))
203       (setq numbers-list (nconc numbers-list (list one-list))))
204     numbers-list))
205
206 (luna-define-method elmo-folder-process-crosspost ((folder elmo-multi-folder))
207   (dolist (child (elmo-multi-folder-children-internal folder))
208     (elmo-folder-process-crosspost child)))
209
210 (luna-define-method elmo-message-fetch ((folder elmo-multi-folder)
211                                         number strategy
212                                         &optional section outbuf unseen)
213   (let ((pair (elmo-multi-real-folder-number folder number)))
214     (elmo-message-fetch (car pair) (cdr pair) strategy section outbuf unseen)))
215
216 (luna-define-method elmo-folder-delete-messages ((folder elmo-multi-folder)
217                                                  numbers)
218   (let ((flds (elmo-multi-folder-children-internal folder))
219         one-list-list
220         (cur-number 0))
221     (setq one-list-list (elmo-multi-split-numbers folder numbers))
222     (while (< cur-number (length flds))
223       (elmo-folder-delete-messages (nth cur-number flds)
224                                    (nth cur-number one-list-list))
225       (setq cur-number (+ 1 cur-number)))
226     t))
227
228 (luna-define-method elmo-folder-detach-messages ((folder elmo-multi-folder)
229                                                  numbers)
230   (let ((flds (elmo-multi-folder-children-internal folder))
231         one-list-list
232         (cur-number 0))
233     (setq one-list-list (elmo-multi-split-numbers folder numbers))
234     (while (< cur-number (length flds))
235       (elmo-folder-detach-messages (nth cur-number flds)
236                                    (nth cur-number one-list-list))
237       (setq cur-number (+ 1 cur-number)))
238     t))
239
240 (luna-define-method elmo-folder-diff ((folder elmo-multi-folder))
241   (elmo-multi-folder-diff folder))
242
243 (defun elmo-multi-folder-diff (folder)
244   (let ((flds (elmo-multi-folder-children-internal folder))
245         (news 0)
246         (unreads 0)
247         (alls 0)
248         no-unreads diff)
249     (while flds
250       (setq diff (elmo-folder-diff (car flds)))
251       (cond
252        ((consp (cdr diff)) ; (new unread all)
253         (setq news    (+ news (nth 0 diff))
254               unreads (+ unreads (nth 1 diff))
255               alls    (+ alls (nth 2 diff))))
256        (t
257         (setq no-unreads t)
258         (setq news    (+ news (car diff))
259               alls    (+ alls (cdr diff)))))
260       (setq flds (cdr flds)))
261     (if no-unreads
262         (cons news alls)
263       (list news unreads alls))))
264
265 (luna-define-method elmo-folder-list-unreads ((folder elmo-multi-folder))
266   (let ((cur-number 0)
267         unreads)
268     (dolist (child (elmo-multi-folder-children-internal folder))
269       (setq cur-number (+ cur-number 1))
270       (setq unreads
271             (nconc
272              unreads
273              (mapcar (lambda (x)
274                        (+ x (* cur-number
275                                (elmo-multi-folder-divide-number-internal
276                                 folder))))
277                      (elmo-folder-list-unreads child)))))
278     unreads))
279
280 (luna-define-method elmo-folder-list-answereds ((folder elmo-multi-folder))
281   (let ((cur-number 0)
282         answereds)
283     (dolist (child (elmo-multi-folder-children-internal folder))
284       (setq cur-number (+ cur-number 1))
285       (setq answereds
286             (nconc
287              answereds
288              (mapcar (lambda (x)
289                        (+ x (* cur-number
290                                (elmo-multi-folder-divide-number-internal
291                                 folder))))
292                      (elmo-folder-list-answereds child)))))
293     answereds))
294
295 (luna-define-method elmo-folder-list-importants ((folder elmo-multi-folder))
296   (let ((cur-number 0)
297         importants)
298     (dolist (child (elmo-multi-folder-children-internal folder))
299       (setq cur-number (+ cur-number 1))
300       (setq importants
301             (nconc
302              importants
303              (mapcar (lambda (x)
304                        (+ x (* cur-number
305                                (elmo-multi-folder-divide-number-internal
306                                 folder))))
307                      (elmo-folder-list-importants child)))))
308     (elmo-uniq-list
309      (nconc importants
310             (elmo-folder-list-messages-with-global-mark
311              folder elmo-msgdb-important-mark)))))
312
313 (luna-define-method elmo-folder-list-messages
314   ((folder elmo-multi-folder) &optional visible-only in-msgdb)
315   (let* ((flds (elmo-multi-folder-children-internal folder))
316          (cur-number 0)
317          list numbers)
318     (while flds
319       (setq cur-number (+ cur-number 1))
320       (setq list (elmo-folder-list-messages (car flds) visible-only in-msgdb))
321       (setq numbers
322             (nconc
323              numbers
324              (mapcar
325               (function
326                (lambda (x)
327                  (+
328                   (* (elmo-multi-folder-divide-number-internal
329                       folder) cur-number) x)))
330               list)))
331       (setq flds (cdr flds)))
332     numbers))
333
334 (luna-define-method elmo-folder-exists-p ((folder elmo-multi-folder))
335   (let ((flds (elmo-multi-folder-children-internal folder)))
336     (catch 'exists
337       (while flds
338         (unless (elmo-folder-exists-p (car flds))
339           (throw 'exists nil))
340         (setq flds (cdr flds)))
341       t)))
342
343 (luna-define-method elmo-folder-creatable-p ((folder elmo-multi-folder))
344   (let ((flds (elmo-multi-folder-children-internal folder)))
345     (catch 'creatable
346       (while flds
347         (when (and (elmo-folder-creatable-p (car flds))
348                    (not (elmo-folder-exists-p (car flds))))
349           ;; If folder already exists, don't to `creatable'.
350           ;; Because this function is called, when folder doesn't exists.
351           (throw 'creatable t))
352         (setq flds (cdr flds)))
353       nil)))
354
355 (luna-define-method elmo-folder-create ((folder elmo-multi-folder))
356   (let ((flds (elmo-multi-folder-children-internal folder)))
357     (catch 'create
358       (while flds
359         (unless (or (elmo-folder-exists-p (car flds))
360                     (elmo-folder-create (car flds)))
361           (throw 'create nil))
362         (setq flds (cdr flds)))
363       t)))
364
365 (luna-define-method elmo-folder-search ((folder elmo-multi-folder)
366                                         condition &optional numlist)
367   (let* ((flds (elmo-multi-folder-children-internal folder))
368          (cur-number 0)
369          numlist-list cur-numlist ; for filtered search.
370          ret-val)
371     (if numlist
372         (setq numlist-list
373               (elmo-multi-split-numbers folder numlist t)))
374     (while flds
375       (setq cur-number (+ cur-number 1))
376       (when numlist
377         (setq cur-numlist (car numlist-list)))
378       (setq ret-val (append
379                      ret-val
380                      (elmo-list-filter
381                       cur-numlist
382                       (mapcar
383                        (function
384                         (lambda (x)
385                           (+
386                            (* (elmo-multi-folder-divide-number-internal
387                                folder) cur-number) x)))
388                        (elmo-folder-search
389                         (car flds) condition)))))
390       (when numlist
391         (setq numlist-list (cdr numlist-list)))
392       (setq flds (cdr flds)))
393     ret-val))
394
395 (luna-define-method elmo-message-use-cache-p ((folder elmo-multi-folder)
396                                               number)
397   (let ((pair (elmo-multi-real-folder-number folder number)))
398     (elmo-message-use-cache-p (car pair) (cdr pair))))
399
400 (luna-define-method elmo-message-file-p ((folder elmo-multi-folder) number)
401   (let ((pair (elmo-multi-real-folder-number folder number)))
402     (elmo-message-file-p (car pair) (cdr pair))))
403
404 (luna-define-method elmo-message-file-name ((folder elmo-multi-folder) number)
405   (let ((pair (elmo-multi-real-folder-number folder number)))
406     (elmo-message-file-name (car pair) (cdr pair))))
407
408 (luna-define-method elmo-folder-plugged-p ((folder elmo-multi-folder))
409   (let ((flds (elmo-multi-folder-children-internal folder)))
410     (catch 'plugged
411       (while flds
412         (unless (elmo-folder-plugged-p (car flds))
413           (throw 'plugged nil))
414         (setq flds (cdr flds)))
415       t)))
416
417 (luna-define-method elmo-folder-set-plugged ((folder elmo-multi-folder)
418                                              plugged add)
419   (let ((flds  (elmo-multi-folder-children-internal folder)))
420     (dolist (fld flds)
421       (elmo-folder-set-plugged fld plugged add))))
422
423 (defun elmo-multi-folder-numbers-list-assoc (folder folder-numbers)
424   (let (ent)
425     (while folder-numbers
426       (when (string= (elmo-folder-name-internal (car (car folder-numbers)))
427                      (elmo-folder-name-internal folder))
428         (setq ent (car folder-numbers)
429               folder-numbers nil))
430       (setq folder-numbers (cdr folder-numbers)))
431     ent))
432
433 (defun elmo-multi-make-folder-numbers-list (folder msgs)
434   (let ((msg-list msgs)
435         pair fld-list
436         ret-val)
437     (while msg-list
438       (when (and (numberp (car msg-list))
439                  (> (car msg-list) 0))
440         (setq pair (elmo-multi-real-folder-number folder (car msg-list)))
441         (if (setq fld-list (elmo-multi-folder-numbers-list-assoc
442                             (car pair)
443                             ret-val))
444             (setcdr fld-list (cons (cdr pair) (cdr fld-list)))
445           (setq ret-val (cons (cons (car pair) (list (cdr pair))) ret-val))))
446       (setq msg-list (cdr msg-list)))
447     ret-val))
448
449 (luna-define-method elmo-folder-mark-as-important ((folder
450                                                     elmo-multi-folder)
451                                                    numbers
452                                                    &optional
453                                                    ignore-flags)
454   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
455     (elmo-folder-mark-as-important (car folder-numbers)
456                                    (cdr folder-numbers)
457                                    ignore-flags)))
458
459 (luna-define-method elmo-folder-unmark-important ((folder
460                                                    elmo-multi-folder)
461                                                   numbers
462                                                   &optional
463                                                   ignore-flags)
464   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
465     (elmo-folder-unmark-important (car folder-numbers)
466                                   (cdr folder-numbers)
467                                   ignore-flags)))
468
469 (luna-define-method elmo-folder-mark-as-read ((folder
470                                                elmo-multi-folder)
471                                               numbers
472                                               &optional ignore-flag)
473   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
474     (elmo-folder-mark-as-read (car folder-numbers)
475                               (cdr folder-numbers)
476                               ignore-flag)))
477
478 (luna-define-method elmo-folder-unmark-read ((folder
479                                               elmo-multi-folder)
480                                              numbers
481                                              &optional ignore-flag)
482   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
483     (elmo-folder-unmark-read (car folder-numbers)
484                              (cdr folder-numbers)
485                              ignore-flag)))
486
487 (luna-define-method elmo-folder-mark-as-answered ((folder
488                                                    elmo-multi-folder)
489                                                   numbers)
490   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
491     (elmo-folder-mark-as-answered (car folder-numbers)
492                                   (cdr folder-numbers))))
493
494 (luna-define-method elmo-folder-unmark-answered ((folder
495                                                   elmo-multi-folder)
496                                                  numbers)
497   (dolist (folder-numbers (elmo-multi-make-folder-numbers-list folder numbers))
498     (elmo-folder-unmark-answered (car folder-numbers)
499                                  (cdr folder-numbers))))
500
501 (luna-define-method elmo-folder-list-flagged ((folder elmo-multi-folder)
502                                               flag
503                                               &optional in-msgdb)
504   (let ((cur-number 0)
505         numbers)
506     (dolist (child (elmo-multi-folder-children-internal folder))
507       (setq cur-number (+ cur-number 1)
508             numbers
509             (nconc
510              numbers
511              (mapcar
512               (function
513                (lambda (x)
514                  (+
515                   (* (elmo-multi-folder-divide-number-internal folder)
516                      cur-number) x)))
517               (elmo-folder-list-flagged child flag in-msgdb)))))
518     numbers))
519
520 (luna-define-method elmo-folder-set-message-modified ((folder
521                                                        elmo-multi-folder)
522                                                       modified)
523   (dolist (child (elmo-multi-folder-children-internal folder))
524     (elmo-folder-set-message-modified child modified)))
525
526 (luna-define-method elmo-folder-commit ((folder elmo-multi-folder))
527   (dolist (child (elmo-multi-folder-children-internal folder))
528     (elmo-folder-commit child)))
529
530 (luna-define-method elmo-folder-length ((folder elmo-multi-folder))
531   (let ((sum 0))
532     (dolist (child (elmo-multi-folder-children-internal folder))
533       (setq sum (+ sum (elmo-folder-length child))))
534     sum))
535
536 (luna-define-method elmo-folder-count-flags ((folder elmo-multi-folder))
537   (let ((new 0)
538         (unreads 0)
539         (answered 0)
540         flags)
541     (dolist (child (elmo-multi-folder-children-internal folder))
542       (setq flags (elmo-folder-count-flags child))
543       (setq new (+ new (nth 0 flags)))
544       (setq unreads (+ unreads (nth 1 flags)))
545       (setq answered (+ answered (nth 2 flags))))
546     (list new unreads answered)))
547
548 (require 'product)
549 (product-provide (provide 'elmo-multi) (require 'elmo-version))
550
551 ;;; elmo-multi.el ends here