Synch up with main trunk.
[elisp/wanderlust.git] / elmo / elmo2.el
1 ;;; elmo2.el -- ELMO main file (I don't remember why this is 2).
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-version)                 ; reduce recursive-load-depth
33 (require 'elmo-vars)
34 (require 'elmo-msgdb)
35 (require 'elmo-cache)
36 (require 'elmo-util)
37 (require 'elmo-dop)
38 ;;;(provide 'elmo2)                     ; circular dependency
39
40 (eval-when-compile
41   (require 'elmo-localdir)
42   (require 'elmo-imap4)
43   (require 'elmo-nntp)
44   (require 'elmo-pop3)
45   (require 'elmo-pipe)
46 ;  (require 'elmo-multi)
47   (require 'elmo-filter)
48   (require 'elmo-archive)
49   ;(require 'elmo-cache2)
50   )
51
52 (if (or (featurep 'dbm)
53         (featurep 'gnudbm)
54         (featurep 'berkdb)
55         (featurep 'berkeley-db))
56     (require 'elmo-database))
57
58 (elmo-define-error 'elmo-error "Error" 'error)
59 (elmo-define-error 'elmo-open-error "Cannot open" 'elmo-error)
60 (elmo-define-error 'elmo-authenticate-error "Login failed" 'elmo-open-error)
61 (elmo-define-error 'elmo-imap4-bye-error "IMAP4 BYE response" 'elmo-open-error)
62
63 (defun elmo-quit ()
64   (interactive)
65   (if (featurep 'elmo-net)
66       (elmo-network-clear-session-cache))
67   (if (get-buffer elmo-work-buf-name)
68       (kill-buffer elmo-work-buf-name)))
69
70 (defun elmo-cleanup-variables ()
71   (setq elmo-folder-info-hashtb nil
72         elmo-nntp-groups-hashtb nil
73         elmo-nntp-list-folders-cache nil
74         ))
75
76 ;;  (cons of max . estimated message number) elmo-max-of-folder (folder)
77 (defun elmo-max-of-folder (folder)
78   (if (elmo-folder-plugged-p folder)
79       (elmo-call-func folder "max-of-folder")
80     (elmo-dop-max-of-folder folder)))
81
82 ;;  list elmo-list-folder (folder)
83 (defun elmo-list-folder (folder)
84   (if (elmo-folder-plugged-p folder)
85       (elmo-call-func folder "list-folder")
86     (elmo-dop-list-folder folder)))
87
88 ;;  list elmo-list-folders (folder)
89 (defun elmo-list-folders (folder &optional hierarchy)
90   (elmo-call-func folder "list-folders" hierarchy))
91
92 ;; bool elmo-folder-exists-p (folder)
93 (defun elmo-folder-exists-p (folder)
94   (if (elmo-folder-plugged-p folder)
95       (elmo-call-func folder "folder-exists-p")
96     (elmo-dop-folder-exists-p folder)))
97
98 ;; bool elmo-folder-creatable-p (folder)
99 (defun elmo-folder-creatable-p (folder)
100   (elmo-call-func folder "folder-creatable-p"))
101
102 ;; bool elmo-create-folder (folder)
103 ;; create folder
104 (defun elmo-create-folder (folder)
105   (if (elmo-folder-plugged-p folder)
106       (elmo-call-func folder "create-folder")
107     (elmo-dop-create-folder folder)))
108
109 (defun elmo-delete-folder (folder)
110   (let ((type (elmo-folder-get-type folder)))
111     (if (or (not (memq type '(localdir localnews archive imap4 maildir)))
112             (if (elmo-folder-plugged-p folder)
113                 (elmo-call-func folder "delete-folder")
114               (elmo-dop-delete-folder folder)))
115         ;; If folder doesn't support delete folder, delete msgdb path only.
116         (elmo-msgdb-delete-path folder))))
117
118 (defun elmo-rename-folder (old-folder new-folder)
119   (let ((old-type (elmo-folder-get-type old-folder))
120         (new-type (elmo-folder-get-type new-folder)))
121     (if (not (eq old-type new-type))
122         (error "not same folder type")
123       (unless (and (memq old-type '(localdir localnews archive imap4))
124                    (elmo-folder-identical-system-p old-folder new-folder))
125         (error "rename folder not supported"))
126       (if (elmo-folder-plugged-p old-folder)
127           (and
128            (if (or (file-exists-p (elmo-msgdb-expand-path new-folder))
129                    (elmo-folder-exists-p new-folder))
130                (error "already exists folder: %s" new-folder)
131              t)
132            (elmo-call-func old-folder "rename-folder"
133                            (elmo-folder-get-spec new-folder))
134            (elmo-msgdb-rename-path old-folder new-folder))
135         (elmo-dop-rename-folder old-folder new-folder)))))
136
137 (defun elmo-read-msg-no-cache (folder msg outbuf &optional unread)
138   "Read messsage specified by FOLDER and MSG(number) into OUTBUF
139 without cacheing.
140 If optional UNREAD is non-nil, message is keeped as unread."
141   (elmo-call-func folder "read-msg" msg outbuf nil unread))
142
143 (defun elmo-force-cache-msg (folder number msgid &optional loc-alist)
144   "Force cache message."
145   (let* ((cache-file (elmo-cache-get-path msgid))
146          dir)
147     (when cache-file
148       (setq dir (directory-file-name (file-name-directory cache-file)))
149       (if (not (file-exists-p dir))
150           (elmo-make-directory dir))
151       (if (elmo-local-file-p folder number)
152           (elmo-copy-file (elmo-get-msg-filename folder number loc-alist)
153                           cache-file)
154         (with-temp-buffer
155           (elmo-call-func folder "read-msg" number (current-buffer))
156           (as-binary-output-file
157            (write-region (point-min) (point-max) cache-file nil 'no-msg)))))))
158
159 (defun elmo-prefetch-msg (folder msg outbuf msgdb)
160   "Read message into outbuf with cacheing."
161   (save-excursion
162     (let* ((number-alist (elmo-msgdb-get-number-alist
163                           (or msgdb (elmo-msgdb-load folder))))
164            (dir (elmo-msgdb-expand-path folder))
165            (message-id (cdr (assq msg number-alist)))
166            type
167            cache-status
168            ret-val part-num real-fld-num)
169       (set-buffer outbuf)
170       (if (elmo-cache-exists-p message-id)
171           t
172         ;; cache doesn't exist.
173         (setq real-fld-num (elmo-get-real-folder-number
174                             folder msg))
175         (setq type (elmo-folder-get-type (car real-fld-num)))
176         (cond ((eq type 'imap4)
177                (setq ret-val (elmo-imap4-prefetch-msg
178                               (elmo-folder-get-spec (car real-fld-num))
179                               (cdr real-fld-num)
180                               outbuf)))
181               ((elmo-folder-local-p (car real-fld-num)))
182               (t (setq ret-val (elmo-call-func (car real-fld-num)
183                                                "read-msg"
184                                                (cdr real-fld-num)
185                                                outbuf
186                                                nil 'unread))))
187         (if ret-val
188             (elmo-cache-save message-id
189                              (elmo-string-partial-p ret-val)
190                              folder msg))
191         (and ret-val t)))))
192
193 (defun elmo-prefetch-msgs (folder msgs)
194   "prefetch messages for queueing."
195   (let* ((msgdb (elmo-msgdb-load folder))
196          (number-alist (elmo-msgdb-get-number-alist msgdb))
197          (len (length msgs))
198          (count 0)
199          msgid msg)
200     (while msgs
201       (setq msg (car msgs))
202       (setq msgid (cdr (assq msg number-alist)))
203       (message "%s:Prefetching... %d/%d message(s)"
204                folder
205                (setq count (+ 1 count)) len)
206       (elmo-force-cache-msg folder msg msgid)
207       (setq msgs (cdr msgs)))))
208
209 ;;  elmo-read-msg (folder msg outbuf msgdb)
210 ;;; read message
211 (defun elmo-read-msg (folder msg outbuf msgdb &optional force-reload unread)
212   "Read message into outbuf."
213   (let ((inhibit-read-only t))
214     (if elmo-inhibit-read-cache
215     ;;Only use elmo-read-msg-with-cache, because if folder is network and
216     ;;elmo-use-cache-p is nil, cannot read important msg. (by muse)
217     ;;(if (not (elmo-use-cache-p folder msg))
218         (elmo-read-msg-no-cache folder msg outbuf unread)
219       (elmo-read-msg-with-cache folder msg outbuf msgdb force-reload unread))))
220
221 (defun elmo-read-msg-with-cache (folder msg outbuf msgdb
222                                         &optional force-reload unread)
223   "Read message into outbuf with cacheing."
224   (let* ((number-alist (elmo-msgdb-get-number-alist
225                         (or msgdb (elmo-msgdb-load folder))))
226          (dir (elmo-msgdb-expand-path folder))
227          (message-id (cdr (assq msg number-alist)))
228          (type (elmo-folder-number-get-type folder msg))
229          cache-status
230          ret-val part-num real-fld-num)
231     (set-buffer outbuf)
232     (if (and (not force-reload)
233              (not (elmo-local-file-p folder msg)))
234         (setq ret-val (elmo-cache-read message-id folder msg)))
235     (if ret-val
236         t
237       ;; cache doesn't exist.
238       (setq real-fld-num (elmo-get-real-folder-number
239                           folder msg))
240       (if (setq ret-val (elmo-call-func (car real-fld-num)
241                                         "read-msg"
242                                         (cdr real-fld-num) outbuf
243                                         nil unread))
244           (if (and message-id
245                    (not (elmo-local-file-p folder msg))
246                    (elmo-use-cache-p folder msg))
247               (elmo-cache-save message-id
248                                (elmo-string-partial-p ret-val)
249                                folder msg)))
250       (and ret-val t))))
251
252 (defun elmo-copy-msgs (src-folder msgs dst-folder &optional msgdb same-number)
253   (let* ((src-spec (elmo-folder-get-spec src-folder))
254          (loc-alist (if msgdb
255                         (elmo-msgdb-get-location msgdb)
256                       (elmo-msgdb-location-load
257                        (elmo-msgdb-expand-path src-spec)))))
258     (if (eq (car src-spec) 'archive)
259         (elmo-archive-copy-msgs-froms
260          (elmo-folder-get-spec dst-folder)
261          msgs src-spec loc-alist same-number)
262       (elmo-call-func dst-folder "copy-msgs"
263                       msgs src-spec loc-alist same-number))))
264
265 (defun elmo-move-msgs (src-folder msgs dst-folder
266                                   &optional msgdb all done
267                                   no-delete-info
268                                   no-delete
269                                   same-number
270                                   unread-marks)
271   (save-excursion
272     (let* ((db (or msgdb (elmo-msgdb-load src-folder)))
273            (number-alist (elmo-msgdb-get-number-alist db))
274            (mark-alist   (elmo-msgdb-get-mark-alist db))
275            (messages msgs)
276            (len (length msgs))
277            (all-msg-num (or all len))
278            (done-msg-num (or done 0))
279            (progress-message (if no-delete
280                                  "Copying messages..."
281                                "Moving messages..."))
282            (tmp-buf (get-buffer-create " *elmo-move-msg*"))
283            ;elmo-no-cache-flag
284            ret-val real-fld-num done-copy dir pair
285            mes-string message-id src-cache i unseen seen-list)
286       (setq i done-msg-num)
287       (set-buffer tmp-buf)
288       (when (and (not (eq dst-folder 'null))
289                  (elmo-folder-direct-copy-p src-folder dst-folder))
290         (message (concat (if no-delete "Copying" "Moving")
291                          " %d message(s)...") (length messages))
292         (unless (elmo-copy-msgs src-folder
293                                 messages
294                                 dst-folder
295                                 db
296                                 same-number)
297           (error "Copy message to %s failed" dst-folder))
298         (setq done-copy t))
299       (while messages
300         (setq real-fld-num (elmo-get-real-folder-number src-folder
301                                                         (car messages)))
302         (setq message-id (cdr (setq pair (assq (car messages) number-alist))))
303         ;; seen-list.
304         (if (and (not (eq dst-folder 'null))
305                  (not (and unread-marks
306                            (setq unseen
307                                  (member
308                                   (cadr (assq (car messages) mark-alist))
309                                   unread-marks)))))
310             (setq seen-list (cons message-id seen-list)))
311         (unless (or (eq dst-folder 'null) done-copy)
312           (if (and (elmo-folder-plugged-p src-folder)
313                    (elmo-folder-plugged-p dst-folder)
314                    (elmo-folder-identical-system-p (car real-fld-num)
315                                                    dst-folder))
316               ;; online and identical system...so copy 'em!
317               (unless
318                   (elmo-copy-msgs (car real-fld-num)
319                                   (list (cdr real-fld-num))
320                                   dst-folder
321                                   db
322                                   same-number)
323                 (error "Copy message to %s failed" dst-folder))
324             ;; use cache if exists.
325             ;; if there's other message with same message-id,
326             ;; don't use cache.
327             (elmo-read-msg src-folder (car messages)
328                            tmp-buf msgdb
329                            (and (elmo-folder-plugged-p src-folder)
330                                 (and pair
331                                      (or
332                                       (rassoc
333                                        message-id
334                                        (cdr (memq pair number-alist)))
335                                       (not (eq pair
336                                                (rassoc message-id
337                                                        number-alist)))))))
338             (unless (eq (buffer-size) 0)
339               (unless (elmo-append-msg dst-folder (buffer-string) message-id
340                                        (if same-number (car messages))
341                                        ;; null means all unread.
342                                        (or (null unread-marks)
343                                            unseen))
344                 (error "move: append message to %s failed" dst-folder)))))
345         ;; delete src cache if it is partial.
346         (elmo-cache-delete-partial message-id src-folder (car messages))
347         (setq ret-val (nconc ret-val (list (car messages))))
348         (when (> all-msg-num elmo-display-progress-threshold)
349           (setq i (+ i 1))
350           (elmo-display-progress
351            'elmo-move-msgs progress-message
352            (/ (* i 100) all-msg-num)))
353         (setq messages (cdr messages)))
354       ;; Save seen-list.
355       (unless (eq dst-folder 'null)
356         (setq dir (elmo-msgdb-expand-path dst-folder))
357         (elmo-msgdb-seen-save dir
358                               (append (elmo-msgdb-seen-load dir) seen-list)))
359       (kill-buffer tmp-buf)
360       (if (and (not no-delete) ret-val)
361           (progn
362             (if (not no-delete-info)
363                 (message "Cleaning up src folder..."))
364             (if (and (elmo-delete-msgs src-folder ret-val db)
365                      (elmo-msgdb-delete-msgs src-folder ret-val db t))
366                 (setq ret-val t)
367               (message "move: delete messages from %s failed." src-folder)
368               (setq ret-val nil)
369               )
370             (if (and ret-val
371                      (not no-delete-info))
372                 (message "Cleaning up src folder...done")
373               )
374             ret-val)
375         (if no-delete
376             (progn
377               (message "Copying messages...done")
378               t)
379           (if (eq len 0)
380               (message "No message was moved.")
381             (message "Moving messages failed.")
382             nil ; failure
383             ))))))
384
385 ;;  boolean elmo-delete-msgs (folder msgs)
386 (defun elmo-delete-msgs (folder msgs &optional msgdb)
387   ;; remove from real folder.
388   (if (elmo-folder-plugged-p folder)
389       (elmo-call-func folder "delete-msgs" msgs)
390     (elmo-dop-delete-msgs folder msgs msgdb)))
391
392 (defun elmo-search (folder condition &optional from-msgs)
393   (if (elmo-folder-plugged-p folder)
394       (elmo-call-func folder "search" condition from-msgs)
395     (elmo-cache-search-all folder condition from-msgs)))
396
397 (defun elmo-msgdb-search (folder condition msgdb)
398   "Search messages which satisfy CONDITION from FOLDER with MSGDB."
399   (let* ((condition (car (elmo-parse-search-condition condition)))
400          (overview (elmo-msgdb-get-overview msgdb))
401          (number-alist (elmo-msgdb-get-number-alist msgdb))
402          (number-list (mapcar 'car number-alist))
403          (length (length overview))
404          (i 0)
405          result)
406     (if (elmo-condition-find-key condition "body")
407         (elmo-search folder condition number-list)
408       (while overview
409         (if (elmo-msgdb-search-internal condition (car overview)
410                                         number-list)
411             (setq result
412                   (cons
413                    (elmo-msgdb-overview-entity-get-number (car overview))
414                    result)))
415         (setq i (1+ i))
416         (elmo-display-progress
417          'elmo-msgdb-search "Searching..." (/ (* i 100) length))
418         (setq overview (cdr overview)))
419       (nreverse result))))
420
421 (defun elmo-msgdb-create (folder numlist new-mark already-mark
422                                  seen-mark important-mark seen-list)
423   (if (elmo-folder-plugged-p folder)
424       (elmo-call-func folder "msgdb-create" numlist new-mark already-mark
425                       seen-mark important-mark seen-list)
426     (elmo-dop-msgdb-create folder numlist new-mark already-mark
427                            seen-mark important-mark seen-list)))
428
429 (defun elmo-make-folder-numbers-list (folder msgs)
430   (let ((msg-list msgs)
431         pair fld-list
432         ret-val)
433     (while msg-list
434       (when (and (numberp (car msg-list))
435                  (> (car msg-list) 0))
436         (setq pair (elmo-get-real-folder-number folder (car msg-list)))
437         (if (setq fld-list (assoc (car pair) ret-val))
438             (setcdr fld-list (cons (cdr pair) (cdr fld-list)))
439           (setq ret-val (cons (cons (car pair) (list (cdr pair))) ret-val))))
440       (setq msg-list (cdr msg-list)))
441     ret-val))
442
443 (defun elmo-call-func-on-markable-msgs (folder func-name msgs msgdb)
444   "Returns t if marked."
445   (save-match-data
446     (let ((folder-numbers (elmo-make-folder-numbers-list folder msgs))
447           type error)
448       (while folder-numbers
449         (if (or (eq
450                  (setq type (car
451                              (elmo-folder-get-spec
452                               (car (car folder-numbers)))))
453                  'imap4)
454                 (memq type '(maildir internal)))
455             (if (elmo-folder-plugged-p folder)
456                 (elmo-call-func (car (car folder-numbers)) func-name
457                                 (cdr (car folder-numbers)))
458               (if elmo-enable-disconnected-operation
459                   (elmo-dop-call-func-on-msgs
460                    (car (car folder-numbers)) ; real folder
461                    func-name
462                    (cdr (car folder-numbers)) ; real number
463                    msgdb)
464                 (setq error t))))
465         (setq folder-numbers (cdr folder-numbers)))
466       (not error))))
467
468 (defun elmo-unmark-important (folder msgs msgdb)
469   (elmo-call-func-on-markable-msgs folder "unmark-important" msgs msgdb))
470   
471 (defun elmo-mark-as-important (folder msgs msgdb)
472   (elmo-call-func-on-markable-msgs folder "mark-as-important" msgs msgdb))
473
474 (defun elmo-mark-as-read (folder msgs msgdb)
475   (elmo-call-func-on-markable-msgs folder "mark-as-read" msgs msgdb))
476
477 (defun elmo-mark-as-unread (folder msgs msgdb)
478   (elmo-call-func-on-markable-msgs folder "mark-as-unread" msgs msgdb))
479
480 (defun elmo-msgdb-create-as-numlist (folder numlist new-mark already-mark
481                                             seen-mark important-mark seen-list)
482   (if (elmo-folder-plugged-p folder)
483       (elmo-call-func folder "msgdb-create-as-numlist" numlist
484                       new-mark already-mark seen-mark important-mark seen-list)
485     (elmo-dop-msgdb-create-as-numlist
486      folder numlist new-mark already-mark
487      seen-mark important-mark seen-list)))
488
489 ;;   msgdb elmo-msgdb-load        (folder)
490 (defun elmo-msgdb-load (folder)
491   (message "Loading msgdb for %s..." folder)
492   (let* ((path (elmo-msgdb-expand-path folder))
493          (overview (elmo-msgdb-overview-load path))
494          (ret-val
495           (list overview
496                 (elmo-msgdb-number-load path)
497                 (elmo-msgdb-mark-load path)
498                 (elmo-msgdb-location-load path)
499                 (elmo-msgdb-make-overview-hashtb overview)
500                 )))
501     (message "Loading msgdb for %s...done" folder)
502     (elmo-folder-set-info-max-by-numdb folder (nth 1 ret-val))
503     ret-val))
504
505 ;;   boolean elmo-msgdb-save (folder msgdb)
506 (defun elmo-msgdb-save (folder msgdb)
507   (message "Saving msgdb for %s..." folder)
508   (save-excursion
509     (let ((path (elmo-msgdb-expand-path folder)))
510       (elmo-msgdb-overview-save path (car msgdb))
511       (elmo-msgdb-number-save path (cadr msgdb))
512       (elmo-msgdb-mark-save path (caddr msgdb))
513       (elmo-msgdb-location-save path (cadddr msgdb))
514     ;(elmo-sync-validity folder);; for validity check!!
515       ))
516   (message "Saving msgdb for %s...done" folder)
517   (elmo-folder-set-info-max-by-numdb folder (cadr msgdb)))
518
519 (defun elmo-msgdb-add-msgs-to-seen-list-subr (msgs msgdb seen-marks seen-list)
520   "Add to seen list."
521   (let* ((seen-mark-list (string-to-char-list seen-marks))
522          (number-alist (elmo-msgdb-get-number-alist msgdb))
523          (mark-alist   (elmo-msgdb-get-mark-alist msgdb))
524          ent)
525     (while msgs
526       (if (setq ent (assq (car msgs) mark-alist))
527           (if (memq (string-to-char (cadr ent)) seen-mark-list)
528               (setq seen-list
529                     (cons (cdr (assq (car msgs) number-alist)) seen-list)))
530         ;; no mark ... seen...
531         (setq seen-list
532               (cons (cdr (assq (car msgs) number-alist)) seen-list)))
533       (setq msgs (cdr msgs)))
534     seen-list))
535
536 (defun elmo-msgdb-add-msgs-to-seen-list (folder msgs msgdb seen-marks)
537   "Add to seen list."
538   (unless (eq folder 'null) ;; black hole
539     (let* ((dir (elmo-msgdb-expand-path folder))
540            (seen-list (elmo-msgdb-seen-load dir)))
541       (setq seen-list
542             (elmo-msgdb-add-msgs-to-seen-list-subr
543              msgs msgdb seen-marks seen-list))
544       (elmo-msgdb-seen-save dir seen-list))))
545
546 ;;  msgdb elmo-append-msg (folder string)
547 (defun elmo-append-msg (folder string &optional message-id msg no-see)
548   (let ((type (elmo-folder-get-type folder))
549         filename)
550     (cond ((eq type 'imap4)
551            (if (elmo-folder-plugged-p folder)
552                (elmo-call-func folder "append-msg" string msg no-see)
553              (elmo-dop-append-msg folder string message-id)))
554           ((eq type 'cache)
555            (if message-id
556                (elmo-cache-append-msg
557                 (elmo-folder-get-spec folder)
558                 string message-id msg no-see)
559              (error "elmo-cache-append-msg require message-id")))
560           (t
561            (elmo-call-func folder "append-msg" string msg no-see)))))
562
563 (defun elmo-check-validity (folder)
564   (elmo-call-func folder "check-validity"
565                   (expand-file-name
566                    elmo-msgdb-validity-filename
567                    (elmo-msgdb-expand-path folder))))
568
569 (defun elmo-pack-number (folder msgdb arg)
570   (let ((type (elmo-folder-get-type folder)))
571     (if (memq type '(localdir localnews maildir))
572         (elmo-call-func folder "pack-number" msgdb arg)
573       (error "pack-number not supported"))))
574
575 (defun elmo-sync-validity (folder)
576   (elmo-call-func folder "sync-validity"
577                   (expand-file-name
578                    elmo-msgdb-validity-filename
579                    (elmo-msgdb-expand-path folder))))
580
581 (defun elmo-use-cache-p (folder number)
582   (elmo-call-func folder "use-cache-p" number)
583   )
584
585 (defun elmo-local-file-p (folder number)
586   (elmo-call-func folder "local-file-p" number))
587
588 (defun elmo-folder-portinfo (folder)
589   (condition-case nil
590       (elmo-call-func folder "portinfo")
591     (error)))
592
593 (defun elmo-folder-plugged-p (folder)
594   (and folder
595        (or (elmo-folder-local-p folder)
596            (elmo-call-func folder "plugged-p"))))
597
598 (defun elmo-folder-set-plugged (folder plugged &optional add)
599   (if (elmo-folder-local-p folder)
600       nil       ;; nop
601     (elmo-call-func folder "set-plugged" plugged add)))
602
603 (defun elmo-generic-sync-number-alist (spec number-alist)
604   "Just return number-alist."
605   number-alist)
606
607 (defun elmo-generic-list-folder-important (spec number-alist)
608   nil)
609
610 (defun elmo-update-number (folder msgdb)
611   (when (elmo-folder-plugged-p folder)
612     (message "Synchronize number...")
613     (let* ((numlist (elmo-msgdb-get-number-alist msgdb))
614            (len (length numlist))
615            new-numlist)
616       (if (eq (length (setq
617                        new-numlist
618                        (elmo-call-func folder "sync-number-alist" numlist)))
619               len)
620           nil
621         (elmo-msgdb-set-number-alist msgdb new-numlist)
622         (message "Synchronize number...done")
623         new-numlist))))
624
625 (defun elmo-get-msg-filename (folder number &optional loc-alist)
626   "Available if elmo-local-file-p is t."
627   (elmo-call-func folder "get-msg-filename" number loc-alist))
628
629 (defun elmo-strict-folder-diff (fld &optional number-alist)
630   (interactive)
631   (let* ((dir (elmo-msgdb-expand-path fld))
632          (nalist (or number-alist
633                      (elmo-msgdb-number-load dir)))
634          (in-db (sort (mapcar 'car nalist) '<))
635          (in-folder  (elmo-list-folder fld))
636          append-list delete-list diff)
637     (cons (if (equal in-folder in-db)
638               0
639             (setq diff (elmo-list-diff
640                         in-folder in-db
641                         nil
642                         ))
643             (setq append-list (car diff))
644             (setq delete-list (cadr diff))
645             (if append-list
646                 (length append-list)
647               (if delete-list
648                   (- 0 (length delete-list))
649                 0)))
650           (length in-folder))))
651
652 (defun elmo-list-folder-unread (folder number-alist mark-alist unread-marks)
653   (elmo-call-func folder "list-folder-unread"
654                   number-alist mark-alist unread-marks))
655
656 (defun elmo-list-folder-important (folder number-alist)
657   (let (importants)
658     ;; Server side importants...(append only.)
659     (if (elmo-folder-plugged-p folder)
660         (setq importants (elmo-call-func folder "list-folder-important"
661                                          number-alist)))
662     (or elmo-msgdb-global-mark-alist
663         (setq elmo-msgdb-global-mark-alist
664               (elmo-object-load (expand-file-name
665                                  elmo-msgdb-global-mark-filename
666                                  elmo-msgdb-dir))))
667     (while number-alist
668       (if (assoc (cdr (car number-alist))
669                  elmo-msgdb-global-mark-alist)
670           (setq importants (cons (car (car number-alist)) importants)))
671       (setq number-alist (cdr number-alist)))
672     importants))
673
674 (defun elmo-generic-commit (folder)
675   nil)
676
677 (defun elmo-commit (folder)
678   (elmo-call-func folder "commit"))
679
680 (defun elmo-clear-killed (folder)
681   (elmo-msgdb-killed-list-save (elmo-msgdb-expand-path folder) nil))
682
683 (defvar elmo-folder-diff-async-callback nil)
684 (defvar elmo-folder-diff-async-callback-data nil)
685
686 (defun elmo-folder-diff-async (folder)
687   "Get diff of FOLDER asynchronously.
688 `elmo-folder-diff-async-callback' is called with arguments of
689 FOLDER and DIFF (cons cell of UNSEEN and MESSAGES).
690 Currently works on IMAP4 folder only."
691   (if (eq (elmo-folder-get-type folder) 'imap4)
692       ;; Only works on imap4 with server diff.
693       (progn
694         (setq elmo-imap4-server-diff-async-callback
695               elmo-folder-diff-async-callback)
696         (setq elmo-imap4-server-diff-async-callback-data
697               elmo-folder-diff-async-callback-data)
698         (elmo-imap4-server-diff-async (elmo-folder-get-spec folder)))
699     (and elmo-folder-diff-async-callback
700          (funcall elmo-folder-diff-async-callback
701                   folder
702                   (elmo-folder-diff folder)))))
703
704 (defun elmo-folder-diff (folder &optional number-list)
705   "Get diff of FOLDER.
706 Return value is a cons cell of NEW and MESSAGES.
707 If optional argumnet NUMBER-LIST is set, it is used as a 
708 message list in msgdb. Otherwise, number-list is load from msgdb."
709   (elmo-call-func folder "folder-diff" folder number-list))
710
711 (defun elmo-crosspost-message-set (message-id folders &optional type)
712   (if (assoc message-id elmo-crosspost-message-alist)
713       (setcdr (assoc message-id elmo-crosspost-message-alist)
714               (list folders type))
715     (setq elmo-crosspost-message-alist
716           (nconc elmo-crosspost-message-alist
717                  (list (list message-id folders type))))))
718
719 (defun elmo-crosspost-message-delete (message-id folders)
720   (let* ((id-fld (assoc message-id elmo-crosspost-message-alist))
721          (folder-list (nth 1 id-fld)))
722     (when id-fld
723       (if (setq folder-list (elmo-list-delete folders folder-list))
724           (setcar (cdr id-fld) folder-list)
725         (setq elmo-crosspost-message-alist
726               (delete id-fld elmo-crosspost-message-alist))))))
727
728
729 (defun elmo-get-msgs-with-mark (mark-alist mark)
730   (let (ret-val)
731     (while mark-alist
732       (if (string= (cadr (car mark-alist)) mark)
733           (cons (car (car mark-alist)) ret-val))
734       (setq mark-alist (cdr mark-alist)))
735     (nreverse ret-val)))
736
737 (defun elmo-buffer-cache-message (fld msg &optional msgdb force-reload unread)
738   (let* ((msg-id (cdr (assq msg (elmo-msgdb-get-number-alist msgdb))))
739          (hit (elmo-buffer-cache-hit (list fld msg msg-id)))
740          (read nil))
741     (if hit
742         (elmo-buffer-cache-sort
743          (elmo-buffer-cache-entry-make (list fld msg msg-id) hit))
744       (setq hit (elmo-buffer-cache-add (list fld msg msg-id)))
745       (setq read t))
746     (if (or force-reload read)
747         (condition-case err
748             (save-excursion
749               (set-buffer hit)
750               (elmo-read-msg fld msg
751                              (current-buffer)
752                              msgdb force-reload
753                              unread))
754           (quit
755            (elmo-buffer-cache-delete)
756            (error "read message %s/%s is quitted" fld msg))
757           (error
758            (elmo-buffer-cache-delete)
759            (signal (car err) (cdr err))
760            nil))) ;; will not be used
761     hit)) ;; retrun value
762
763 (defun elmo-read-msg-with-buffer-cache (fld msg outbuf msgdb &optional force-reload)
764   (if elmo-use-buffer-cache
765       (let (hit start end)
766         (when (setq hit (elmo-buffer-cache-message
767                          (elmo-string fld) msg
768                          msgdb force-reload))
769           (erase-buffer)
770           (save-excursion
771             (set-buffer hit)
772             (setq start (point-min) end (point-max)))
773           (insert-buffer-substring hit start end)))
774     (elmo-read-msg fld msg outbuf msgdb force-reload)))
775
776 (defun elmo-folder-pipe-p (folder)
777   (let ((type (elmo-folder-get-type folder)))
778     (cond
779      ((eq type 'multi)
780       (let ((flds (cdr (elmo-folder-get-spec folder))))
781         (catch 'done
782           (while flds
783             (if (elmo-folder-pipe-p (car flds))
784                 (throw 'done t)))
785           nil)))
786      ((eq type 'pipe)
787       t)
788      ((eq type 'filter)
789       (elmo-folder-pipe-p
790        (nth 2 (elmo-folder-get-spec folder))))
791      (t
792       nil
793       ))))
794
795 (defun elmo-multi-p (folder)
796   (let ((type (elmo-folder-get-type folder)))
797     (cond
798      ((eq type 'multi)
799       t)
800      ((eq type 'pipe)
801       (elmo-multi-p
802        (elmo-pipe-spec-dst (elmo-folder-get-spec folder))))
803      ((eq type 'filter)
804       (elmo-multi-p
805        (nth 2 (elmo-folder-get-spec folder))))
806      (t
807       nil
808       ))))
809
810 (defun elmo-get-real-folder-number (folder number)
811   (let ((type (elmo-folder-get-type folder)))
812     (cond
813      ((eq type 'multi)
814       (elmo-multi-get-real-folder-number folder number))
815      ((eq type 'pipe)
816       (elmo-get-real-folder-number
817        (elmo-pipe-spec-dst (elmo-folder-get-spec folder) )
818        number))
819      ((eq type 'filter)
820       (elmo-get-real-folder-number
821        (nth 2 (elmo-folder-get-spec folder)) number))
822      (t
823       (cons folder number)
824       ))))
825
826 (defun elmo-folder-get-primitive-spec-list (folder &optional spec-list)
827   (let ((type (elmo-folder-get-type folder))
828         specs)
829     (cond
830      ((or (eq type 'multi)
831           (eq type 'pipe))
832       (let ((flds (cdr (elmo-folder-get-spec folder)))
833             spec)
834         (while flds
835           (setq spec (elmo-folder-get-primitive-spec-list (car flds)))
836           (if (not (memq (car spec) specs))
837               (setq specs (append specs spec)))
838           (setq flds (cdr flds)))))
839      ((eq type 'filter)
840       (setq specs
841             (elmo-folder-get-primitive-spec-list
842              (nth 2 (elmo-folder-get-spec folder)))))
843      (t
844       (setq specs (list (elmo-folder-get-spec folder)))
845       ))
846     specs))
847
848 (defun elmo-folder-get-primitive-folder-list (folder)
849   (let* ((type (elmo-folder-get-type folder)))
850     (cond
851      ((or (eq type 'multi)
852           (eq type 'pipe))
853       (let ((flds (cdr (elmo-folder-get-spec folder)))
854             ret-val)
855         (while flds
856           (setq ret-val (append ret-val
857                                 (elmo-folder-get-primitive-folder-list
858                                  (car flds))))
859           (setq flds (cdr flds)))
860         ret-val))
861      ((eq type 'filter)
862       (elmo-folder-get-primitive-folder-list
863        (nth 2 (elmo-folder-get-spec folder))))
864      (t
865       (list folder)
866       ))))
867
868 (defun elmo-folder-contains-multi (folder)
869   (let ((cur-spec (elmo-folder-get-spec folder)))
870     (catch 'done
871       (while cur-spec
872         (cond
873          ((eq (car cur-spec) 'filter)
874           (setq cur-spec (elmo-folder-get-spec (nth 2 cur-spec))))
875          ((eq (car cur-spec) 'pipe)
876           (setq cur-spec (elmo-folder-get-spec (elmo-pipe-spec-src cur-spec))))
877          ((eq (car cur-spec) 'multi)
878           (throw 'done nil))
879          (t (setq cur-spec nil)))))
880     cur-spec))
881
882 (defun elmo-folder-contains-type (folder type)
883   (let ((spec (elmo-folder-get-spec folder)))
884     (cond
885      ((eq (car spec) 'filter)
886       (elmo-folder-contains-type (nth 2 spec) type))
887      ((eq (car spec) 'pipe)
888       (elmo-folder-contains-type (elmo-pipe-spec-dst spec) type))
889      ((eq (car spec) 'multi)
890       (let ((folders (cdr spec)))
891         (catch 'done
892           (while folders
893             (if (elmo-folder-contains-type (car folders) type)
894                 (throw 'done t))
895             (setq folders (cdr folders))))))
896      ((eq (car spec) type)
897       t)
898      (t nil))))
899
900 (defun elmo-folder-number-get-spec (folder number)
901   (let ((type (elmo-folder-get-type folder)))
902     (cond
903      ((eq type 'multi)
904       (elmo-multi-folder-number-get-spec folder number))
905      ((eq type 'pipe)
906       (elmo-folder-number-get-spec
907        (elmo-pipe-spec-dst (elmo-folder-get-spec folder)) number))
908      ((eq type 'filter)
909       (elmo-folder-number-get-spec
910        (nth 2 (elmo-folder-get-spec folder)) number))
911      (t
912       (elmo-folder-get-spec folder)
913       ))))
914
915 (defun elmo-folder-number-get-type (folder number)
916   (car (elmo-folder-number-get-spec folder number)))
917
918 (defun elmo-multi-folder-number-get-spec (folder number)
919   (let* ((spec (elmo-folder-get-spec folder))
920          (flds (cdr spec))
921          (fld (nth (- (/ number elmo-multi-divide-number) 1) flds)))
922     (elmo-folder-number-get-spec fld number)))
923
924 ;; autoloads
925 (autoload 'elmo-nntp-make-groups-hashtb "elmo-nntp")
926 (autoload 'elmo-nntp-post "elmo-nntp")
927 (autoload 'elmo-localdir-max-of-folder "elmo-localdir")
928 (autoload 'elmo-localdir-msgdb-create-overview-entity-from-file "elmo-localdir")
929 (autoload 'elmo-archive-copy-msgs-froms "elmo-archive")
930
931 (require 'product)
932 (product-provide (provide 'elmo2) (require 'elmo-version))
933
934 ;;; elmo2.el ends here