* wl-summary.el (wl-summary-update-mark): Ignore errors while
[elisp/wanderlust.git] / elmo / elmo.el
1 ;;; elmo.el --- Elisp Library for Message Orchestration.
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 'luna)
33
34 (require 'elmo-version)                 ; reduce recursive-load-depth
35 (require 'elmo-vars)
36 (require 'elmo-util)
37 (require 'elmo-msgdb)
38
39 (eval-when-compile (require 'cl))
40
41 (if (or (featurep 'dbm)
42         (featurep 'gnudbm)
43         (featurep 'berkdb)
44         (featurep 'berkeley-db))
45     (require 'elmo-database))
46
47 (defcustom elmo-message-fetch-threshold 30000
48   "Fetch threshold."
49   :type 'integer
50   :group 'elmo)
51
52 (defcustom elmo-message-fetch-confirm t
53   "If non-nil, confirm fetching if message size is larger than
54 `elmo-message-fetch-threshold'.
55 Otherwise, entire fetching of the message is aborted without confirmation."
56   :type 'boolean
57   :group 'elmo)
58
59 (defcustom elmo-folder-update-threshold 500
60   "Update threshold."
61   :type 'integer
62   :group 'elmo)
63
64 (defcustom elmo-folder-update-confirm t
65   "Confirm if update number exceeds `elmo-folder-update-threshold'."
66   :type 'boolean
67   :group 'elmo)
68
69 (defvar elmo-message-displaying nil
70   "A global switch to indicate message is displaying or not.")
71
72 ;;; internal
73 (defvar elmo-folder-type-alist nil)
74
75 (defvar elmo-newsgroups-hashtb nil)
76
77 (elmo-define-error 'elmo-error "Error" 'error)
78 (elmo-define-error 'elmo-open-error "Cannot open" 'elmo-error)
79 (elmo-define-error 'elmo-authenticate-error "Login failed" 'elmo-open-error)
80 (elmo-define-error 'elmo-imap4-bye-error "IMAP4 session was terminated" 'elmo-open-error)
81
82 (defun elmo-define-folder (prefix backend)
83   "Define a folder.
84 If a folder name begins with PREFIX, use BACKEND."
85   (let ((pair (assq prefix elmo-folder-type-alist)))
86     (if pair
87         (progn
88           (setcar pair prefix)
89           (setcdr pair backend))
90       (setq elmo-folder-type-alist (cons (cons prefix backend)
91                                          elmo-folder-type-alist)))))
92
93 (defmacro elmo-folder-type (name)
94   "Get folder type from NAME string."
95   (` (and (stringp (, name))
96           (cdr (assoc (string-to-char (, name)) elmo-folder-type-alist)))))
97
98 ;;; ELMO folder
99 ;; A elmo folder provides uniformed (orchestrated) access
100 ;; to the internet messages.
101 (eval-and-compile
102   (luna-define-class elmo-folder () (type   ; folder type symbol.
103                                      name   ; orignal folder name string.
104                                      prefix ; prefix for folder name
105                                      path   ; directory path for msgdb.
106                                      msgdb  ; msgdb (may be nil).
107                                      killed-list  ; killed list.
108                                      persistent   ; non-nil if persistent.
109                                      message-modified ; message is modified.
110                                      mark-modified    ; mark is modified.
111                                      process-duplicates  ; read or hide
112                                      biff   ; folder for biff
113                                      ))
114   (luna-define-internal-accessors 'elmo-folder))
115
116 (luna-define-generic elmo-folder-initialize (folder name)
117   ;; Initialize a FOLDER structure with NAME."
118   )
119
120 (defmacro elmo-folder-send (folder message &rest args)
121   "Let FOLDER receive the MESSAGE with ARGS."
122   (` (luna-send (, folder) (, message) (, folder) (,@ args))))
123
124 ;;;###autoload
125 (defun elmo-make-folder (name &optional non-persistent)
126   "Make an ELMO folder structure specified by NAME.
127 If optional argument NON-PERSISTENT is non-nil, the folder msgdb is not saved."
128   (let ((type (elmo-folder-type name))
129         prefix split class folder original)
130     (setq original (elmo-string name))
131     (if type
132         (progn
133           (setq prefix (substring name 0 1))
134           (setq name (substring name 1)))
135       (setq type (intern (car (setq split (split-string name ":")))))
136       (if (> (length split) 2)
137           (setq name (substring name (+ 1 (length (car split)))))
138         (error "Error in folder name `%s'" original))
139       (setq prefix (concat (car split) ":")))
140     (setq class (format "elmo-%s" (symbol-name type)))
141     (require (intern class))
142     (setq folder (luna-make-entity (intern (concat class "-folder"))
143                                    :type type
144                                    :prefix prefix
145                                    :name original
146                                    :persistent (not non-persistent)))
147     (save-match-data
148       (elmo-folder-send folder 'elmo-folder-initialize name))))
149
150 ;; Note that this function is for internal use only.
151 (luna-define-generic elmo-folder-msgdb (folder)
152   "Return the msgdb of FOLDER (on-demand loading).
153 \(For internal use only.\)")
154
155 (luna-define-method elmo-folder-msgdb ((folder elmo-folder))
156   (or (elmo-folder-msgdb-internal folder)
157       (elmo-folder-set-msgdb-internal folder
158                                       (elmo-msgdb-load folder))))
159 (luna-define-generic elmo-folder-open (folder &optional load-msgdb)
160   "Open and setup (load saved status) FOLDER.
161 If optional LOAD-MSGDB is non-nil, msgdb is loaded.
162 \(otherwise, msgdb is loaded on-demand)")
163
164 (luna-define-generic elmo-folder-open-internal (folder)
165   "Open FOLDER (without loading saved folder status).")
166
167 (luna-define-generic elmo-folder-check (folder)
168   "Check the FOLDER to obtain newest information at the next list operation.")
169
170 (luna-define-generic elmo-folder-clear (folder &optional keep-killed)
171   "Clear FOLDER to the initial state.
172 If optional KEEP-KILLED is non-nil, killed-list is not cleared.")
173
174 (luna-define-generic elmo-folder-commit (folder)
175   "Save current status of FOLDER.")
176
177 (luna-define-generic elmo-folder-close (folder)
178   "Close, save and clearnup FOLDER.")
179
180 (luna-define-generic elmo-folder-close-internal (folder)
181   "Close FOLDER (without saving folder status).")
182
183 (luna-define-generic elmo-folder-plugged-p (folder)
184   "Returns t if FOLDER is plugged.")
185
186 (luna-define-generic elmo-folder-set-plugged (folder plugged &optional add)
187   "Set FOLDER as plugged.")
188
189 (luna-define-generic elmo-net-port-info (folder)
190   "Get port information of FOLDER.")
191
192 (luna-define-generic elmo-folder-use-flag-p (folder)
193   "Returns t if FOLDER treats unread/important flag itself.")
194
195 (luna-define-generic elmo-folder-diff (folder &optional numbers)
196   "Get diff of FOLDER.
197 If optional NUMBERS is set, it is used as current NUMBERS.
198 Otherwise, saved status for folder is used for comparison.
199 Return value is cons cell or list:
200  - a cons cell (new . all)
201  - a list (new unread all)")
202
203 (luna-define-generic elmo-folder-status (folder)
204   "Returns a cons cell of (MAX-NUMBER . MESSAGES) in the FOLDER.")
205
206 (luna-define-generic elmo-folder-reserve-status-p (folder)
207   "If non-nil, the folder should not close folder after `elmo-folder-status'.")
208
209 (luna-define-generic elmo-folder-list-messages (folder &optional visible-only
210                                                        in-msgdb)
211   "Return a list of message numbers contained in FOLDER.
212 If optional VISIBLE-ONLY is non-nil, killed messages are not listed.
213 If second optional IN-MSGDB is non-nil, only messages in the msgdb are listed.")
214 (luna-define-method elmo-folder-list-messages ((folder elmo-folder)
215                                                &optional visible-only in-msgdb)
216   (let ((list (if in-msgdb
217                   t
218                 (elmo-folder-list-messages-internal folder visible-only))))
219     (elmo-living-messages
220      (if (listp list)
221          list
222        ;; Use current list.
223        (elmo-msgdb-list-messages (elmo-folder-msgdb folder)))
224      (elmo-folder-killed-list-internal folder))))
225
226 (luna-define-generic elmo-folder-list-unreads (folder)
227   "Return a list of unread message numbers contained in FOLDER.")
228 (luna-define-generic elmo-folder-list-importants (folder)
229   "Return a list of important message numbers contained in FOLDER.")
230 (luna-define-generic elmo-folder-list-answereds (folder)
231   "Return a list of answered message numbers contained in FOLDER.")
232
233 ;; TODO: Should reconsider the structure of global mark.
234 (defun elmo-folder-list-messages-with-global-mark (folder mark)
235   (let (entity msgs)
236     (dolist (mark-pair (or elmo-msgdb-global-mark-alist
237                            (setq elmo-msgdb-global-mark-alist
238                                  (elmo-object-load
239                                   (expand-file-name
240                                    elmo-msgdb-global-mark-filename
241                                    elmo-msgdb-directory)))))
242       (if (and (string= mark (cdr mark-pair))
243                (setq entity
244                      (elmo-msgdb-overview-get-entity (car mark-pair)
245                                                      (elmo-folder-msgdb
246                                                       folder))))
247           (setq msgs (cons (elmo-msgdb-overview-entity-get-number entity)
248                            msgs))))
249     msgs))
250
251 (luna-define-generic elmo-folder-list-flagged (folder flag &optional in-msgdb)
252   "List messages in the FOLDER with FLAG.
253 FLAG is a symbol which is one of the following:
254   `new'        (new messages)
255   `unread'     (unread messages (new messages are included))
256   `answered'   (answered or forwarded)
257   `important'  (marked as important)
258 'sugar' flags:
259   `read'       (not unread)
260   `digest'     (unread + important)
261   `any'        (digest + answered)
262
263 If optional IN-MSGDB is non-nil, retrieve flag information from msgdb.")
264
265 (luna-define-method elmo-folder-list-flagged ((folder elmo-folder) flag
266                                               &optional in-msgdb)
267   ;; Currently, only in-msgdb is implemented.
268   (elmo-msgdb-list-flagged (elmo-folder-msgdb folder) flag))
269
270 (luna-define-method elmo-folder-list-unreads ((folder elmo-folder))
271   (elmo-folder-list-flagged folder 'unread))
272
273 (luna-define-method elmo-folder-list-importants ((folder elmo-folder))
274   (elmo-folder-list-flagged folder 'important))
275
276 (luna-define-method elmo-folder-list-answereds ((folder elmo-folder))
277   (elmo-folder-list-flagged folder 'answered))
278
279 (luna-define-generic elmo-folder-list-messages-internal (folder &optional
280                                                                 visible-only)
281   ;; Return a list of message numbers contained in FOLDER.
282   ;; Return t if the message list is not available.
283   )
284
285 (luna-define-generic elmo-folder-list-subfolders (folder &optional one-level)
286   "Returns a list of subfolders contained in FOLDER.
287 If optional argument ONE-LEVEL is non-nil, only children of FOLDER is returned.
288 \(a folder which have children is returned as a list\)
289 Otherwise, all descendent folders are returned.")
290
291 (luna-define-generic elmo-folder-have-subfolder-p (folder)
292   "Return non-nil when FOLDER has subfolders.")
293
294 (luna-define-generic elmo-folder-exists-p (folder)
295   "Returns non-nil when FOLDER exists.")
296
297 (luna-define-generic elmo-folder-creatable-p (folder)
298   "Returns non-nil when FOLDER is creatable.")
299
300 (luna-define-generic elmo-folder-writable-p (folder)
301   "Returns non-nil when FOLDER is writable.")
302
303 (luna-define-generic elmo-folder-persistent-p (folder)
304   "Return non-nil when FOLDER is persistent.")
305
306 (luna-define-generic elmo-folder-create (folder)
307   "Create a FOLDER.")
308
309 (luna-define-generic elmo-message-deletable-p (folder number)
310   "Returns non-nil when the message in the FOLDER with NUMBER is deletable.")
311
312 (luna-define-generic elmo-folder-delete (folder)
313   "Delete FOLDER completely.")
314
315 (luna-define-generic elmo-folder-rename (folder new-name)
316   "Rename FOLDER to NEW-NAME (string).")
317
318 (luna-define-generic elmo-folder-delete-messages (folder numbers)
319   "Delete messages.
320 FOLDER is the ELMO folder structure.
321 NUMBERS is a list of message numbers to be deleted.")
322
323 (luna-define-generic elmo-folder-search (folder condition &optional numbers)
324   "Search and return list of message numbers.
325 FOLDER is the ELMO folder structure.
326 CONDITION is a condition structure for searching.
327 If optional argument NUMBERS is specified and is a list of message numbers,
328 messages are searched from the list.")
329
330 (luna-define-generic elmo-message-match-condition (folder number
331                                                           condition
332                                                           numbers)
333   "Return non-nil when the message in the FOLDER with NUMBER is matched.
334 CONDITION is a condition structure for testing.
335 NUMBERS is a list of message numbers,
336 use to be test for \"last\" and \"first\" predicates.")
337
338 (luna-define-generic elmo-folder-msgdb-create (folder numbers flag-table)
339   "Create a message database (implemented in each backends).
340 FOLDER is the ELMO folder structure.
341 NUMBERS is a list of message numbers to create msgdb.
342 FLAG-TABLE is a hashtable of message-id and flag.")
343
344 (luna-define-generic elmo-folder-unmark-important (folder
345                                                    numbers
346                                                    &optional ignore-flags)
347   "Un-mark messages as important.
348 FOLDER is the ELMO folder structure.
349 NUMBERS is a list of message numbers to be processed.
350 If IGNORE-FLAGS is non-nil, folder flags are not updated.")
351
352 (luna-define-generic elmo-folder-mark-as-important (folder
353                                                     numbers
354                                                     &optional ignore-flags)
355   "Mark messages as important.
356 FOLDER is the ELMO folder structure.
357 NUMBERS is a list of message numbers to be processed.
358 If IGNORE-FLAGS is non-nil, folder flags are not updated.")
359
360 (luna-define-generic elmo-folder-unmark-read (folder numbers
361                                                      &optional ignore-flags)
362   "Un-mark messages as read.
363 FOLDER is the ELMO folder structure.
364 NUMBERS is a list of message numbers to be processed.
365 If IGNORE-FLAGS is non-nil, folder flags are not updated.")
366
367 (luna-define-generic elmo-folder-mark-as-read (folder numbers
368                                                       &optional ignore-flags)
369   "Mark messages as read.
370 FOLDER is the ELMO folder structure.
371 NUMBERS is a list of message numbers to be processed.
372 If IGNORE-FLAGS is non-nil, folder flags are not updated.")
373
374 (luna-define-generic elmo-folder-unmark-answered (folder numbers)
375   "Un-mark messages as answered.
376 FOLDER is the ELMO folder structure.
377 NUMBERS is a list of message numbers to be processed.")
378
379 (luna-define-generic elmo-folder-mark-as-answered (folder numbers)
380   "Mark messages as answered.
381 FOLDER is the ELMO folder structure.
382 NUMBERS is a list of message numbers to be processed.")
383
384 (luna-define-generic elmo-folder-append-buffer (folder &optional flag
385                                                        number)
386   "Append current buffer as a new message.
387 FOLDER is the destination folder(ELMO folder structure).
388 FLAG is the status of appended message.
389 If optional argument NUMBER is specified, the new message number is set
390 \(if possible\).")
391
392 (luna-define-generic elmo-folder-append-messages (folder
393                                                   src-folder
394                                                   numbers
395                                                   &optional
396                                                   same-number)
397   "Append messages from folder.
398 FOLDER is the ELMO folder structure.
399 Caller should make sure FOLDER is `writable'.
400 (Can be checked with `elmo-folder-writable-p').
401 SRC-FOLDER is the source ELMO folder structure.
402 NUMBERS is the message numbers to be appended in the SRC-FOLDER.
403 If second optional argument SAME-NUMBER is specified,
404 message number is preserved (if possible).")
405
406 (luna-define-generic elmo-folder-pack-numbers (folder)
407   "Pack message numbers of FOLDER.")
408
409 (luna-define-generic elmo-folder-update-number (folder)
410   "Update number of FOLDER.")
411
412 (luna-define-generic elmo-folder-diff-async (folder)
413   "Get diff of FOLDER asynchronously.")
414
415 (luna-define-generic elmo-folder-expand-msgdb-path (folder)
416   "Expand path for FOLDER.")
417
418 (luna-define-generic elmo-folder-get-primitive-list (folder)
419   "Get primitive folder structure list contained in FOLDER.")
420
421 (luna-define-generic elmo-folder-contains-type (folder type)
422   "Returns t if FOLDER contains TYPE.")
423
424 (luna-define-generic elmo-folder-local-p (folder)
425   "Returns t if FOLDER is local.")
426
427 (luna-define-generic elmo-folder-message-file-p (folder)
428   "Returns t if all messages in the FOLDER are files.")
429
430 ;;; Message methods.
431 (luna-define-generic elmo-message-use-cache-p (folder number)
432   "Returns t if the message in the FOLDER with NUMBER uses cache.")
433
434 (luna-define-generic elmo-message-file-name (folder number)
435   "Return the file name of a message specified by FOLDER and NUMBER.")
436
437 ;;; For archive
438
439 ;;; Use original file
440 (luna-define-generic elmo-folder-message-file-number-p (folder)
441   "Return t if the file name in the FOLDER is the message number.")
442
443 (luna-define-generic elmo-folder-message-file-directory (folder)
444   "Return the directory of the message files of FOLDER.")
445
446 ;;; Use temporary file
447 (luna-define-generic elmo-folder-message-make-temp-file-p (folder)
448   "Return t if the messages in the FOLDER makes local temporary file.")
449
450 (luna-define-generic elmo-folder-message-make-temp-files (folder
451                                                           numbers
452                                                           &optional
453                                                           start-number)
454   "Make a new temporary files from the messages in the FOLDER with NUMBERS.
455 If START-NUMBER is specified, temporary files begin from the number.
456 Otherwise, same number is used for temporary files.
457 Return newly created temporary directory name which contains temporary files.")
458
459 (luna-define-generic elmo-message-file-p (folder number)
460   "Return t if message in the FOLDER with NUMBER is a file.")
461
462 (luna-define-generic elmo-find-fetch-strategy
463   (folder entity &optional ignore-cache)
464 ;; Returns the message fetching strategy suitable for the message.
465 ;; FOLDER is the ELMO folder structure.
466 ;; ENTITY is the overview entity of the message in the folder.
467 ;; If optional argument IGNORE-CACHE is non-nil, cache is ignored.
468 ;; Returned value is a elmo-fetch-strategy object.
469 ;; If return value is nil, message should not be nil.
470   )
471
472 (defmacro elmo-make-fetch-strategy (entireness
473                                     &optional
474                                     use-cache
475                                     save-cache
476                                     cache-path)
477 ;; Make elmo-message-fetching strategy.
478 ;; ENTIRENESS is 'entire or 'section.
479 ;; 'entire means fetch message entirely at once.
480 ;; 'section means fetch message section by section.
481 ;; If optional USE-CACHE is non-nil, existing cache is used and otherwise,
482 ;; existing cache is thrown away.
483 ;; If SAVE-CACHE is non-nil, fetched message is saved.
484 ;; CACHE-PATH is the cache path to be used as a message cache file.
485   (` (vector (, entireness)
486              (, use-cache) (, save-cache) (, cache-path))))
487
488 (defmacro elmo-fetch-strategy-entireness (strategy)
489   ;; Return entireness of STRATEGY.
490   (` (aref (, strategy) 0)))
491
492 (defmacro elmo-fetch-strategy-use-cache (strategy)
493   ;; Return use-cache of STRATEGY.
494   (` (aref (, strategy) 1)))
495
496 (defmacro elmo-fetch-strategy-save-cache (strategy)
497   ;; Return save-cache of STRATEGY.
498   (` (aref (, strategy) 2)))
499
500 (defmacro elmo-fetch-strategy-cache-path (strategy)
501   ;;  Return cache-path of STRATEGY.
502   (` (aref (, strategy) 3)))
503
504 (luna-define-method elmo-find-fetch-strategy
505   ((folder elmo-folder) entity &optional ignore-cache)
506   (let (cache-file size message-id number)
507     (setq size (elmo-msgdb-overview-entity-get-size entity))
508     (setq message-id (elmo-msgdb-overview-entity-get-id entity))
509     (setq number (elmo-msgdb-overview-entity-get-number entity))
510     (setq cache-file (elmo-file-cache-get message-id))
511     (setq ignore-cache (or ignore-cache
512                            (null (elmo-message-use-cache-p folder number))))
513     (if (or ignore-cache
514             (null (elmo-file-cache-status cache-file)))
515         ;; No cache or ignore-cache.
516         (if (and (not (elmo-folder-local-p folder))
517                  elmo-message-fetch-threshold
518                  (integerp size)
519                  (>= size elmo-message-fetch-threshold)
520                  (or (not elmo-message-fetch-confirm)
521                      (not (prog1 (y-or-n-p
522                                   (format "Fetch entire message(%dbytes)? "
523                                           size))
524                             (message "")))))
525             ;; Don't fetch message at all.
526             nil
527           ;; Don't use existing cache and fetch entire message at once.
528           (elmo-make-fetch-strategy
529            'entire nil
530            (elmo-message-use-cache-p folder number)
531            (elmo-file-cache-path cache-file)))
532       ;; Cache exists.
533       (if (not ignore-cache)
534           (elmo-make-fetch-strategy
535            'entire
536            ;; ...But ignore current section cache and re-fetch
537            ;; if section cache.
538            (not (eq (elmo-file-cache-status cache-file) 'section))
539            ;; Save cache.
540            (elmo-message-use-cache-p folder number)
541            (elmo-file-cache-path cache-file))))))
542
543 (luna-define-method elmo-folder-list-messages-internal
544   ((folder elmo-folder) &optional visible-only)
545   t)
546
547 (defun elmo-folder-encache (folder numbers &optional unread)
548   "Encache messages in the FOLDER with NUMBERS.
549 If UNREAD is non-nil, messages are not marked as read."
550   (dolist (number numbers)
551     (elmo-message-encache folder number unread)))
552
553 (luna-define-generic elmo-message-encache (folder number &optional read)
554   "Encache message in the FOLDER with NUMBER.
555 If READ is non-nil, message is marked as read.")
556
557 (luna-define-method elmo-message-encache ((folder elmo-folder) number
558                                           &optional read)
559   (elmo-message-fetch
560    folder number
561    (elmo-make-fetch-strategy 'entire
562                              nil ;use-cache
563                              t   ;save-cache
564                              (elmo-file-cache-get-path
565                               (elmo-message-field
566                                folder number 'message-id)))
567    nil nil (not read)))
568
569 (luna-define-generic elmo-message-fetch (folder number strategy
570                                                 &optional
571                                                 section
572                                                 outbuf
573                                                 unread)
574   "Fetch a message and return as a string.
575 FOLDER is the ELMO folder structure.
576 NUMBER is the number of the message in the FOLDER.
577 STRATEGY is the message fetching strategy.
578 If optional argument SECTION is specified, only the SECTION of the message
579 is fetched (if possible).
580 If second optional argument OUTBUF is specified, fetched message is
581 inserted to the buffer and returns t if fetch was ended successfully.
582 If third optional argument UNREAD is non-nil, message is not marked as read.
583 Returns non-nil if fetching was succeed.")
584
585 (luna-define-generic elmo-message-fetch-with-cache-process (folder
586                                                             number strategy
587                                                             &optional
588                                                             section
589                                                             unread)
590   "Fetch a message into current buffer with cache process.
591 FOLDER is the ELMO folder structure.
592 NUMBER is the number of the message in the FOLDER.
593 STRATEGY is the message fetching strategy.
594 If optional argument SECTION is specified, only the SECTION of the message
595 is fetched (if possible).
596 If second optional argument UNREAD is non-nil, message is not marked as read.
597 Returns non-nil if fetching was succeed.")
598
599 (luna-define-generic elmo-message-fetch-internal (folder number strategy
600                                                          &optional
601                                                          section
602                                                          unread)
603   "Fetch a message into current buffer.
604 FOLDER is the ELMO folder structure.
605 NUMBER is the number of the message in the FOLDER.
606 STRATEGY is the message fetching strategy.
607 If optional argument SECTION is specified, only the SECTION of the message
608 is fetched (if possible).
609 If second optional argument UNREAD is non-nil, message is not marked as read.
610 Returns non-nil if fetching was succeed.")
611
612 (luna-define-generic elmo-message-fetch-field (folder number field)
613   "Fetch a message field value.
614 FOLDER is the ELMO folder structure.
615 NUMBER is the number of the message in the FOLDER.
616 FIELD is a symbol of the field name.")
617
618 (luna-define-generic elmo-message-folder (folder number)
619   "Get primitive folder of the message.")
620
621 (luna-define-generic elmo-folder-process-crosspost (folder)
622   "Process crosspost for FOLDER.
623 If NUMBER-ALIST is set, it is used as number-alist.
624 Return a cons cell of (NUMBER-CROSSPOSTS . NEW-MARK-ALIST).")
625
626 (luna-define-generic elmo-folder-append-msgdb (folder append-msgdb)
627   "Append  APPEND-MSGDB to the current msgdb of the folder.")
628
629 (luna-define-generic elmo-folder-newsgroups (folder)
630   "Return list of newsgroup name of FOLDER.")
631
632 (luna-define-generic elmo-folder-search-requires-msgdb-p (folder condition)
633   "Return non-nil if searching in FOLDER by CONDITION requires msgdb fetch.")
634
635 (defun elmo-folder-search-requires-msgdb-p-internal (folder condition)
636   (if (listp condition)
637       (or (elmo-folder-search-requires-msgdb-p-internal
638            folder (nth 1 condition))
639           (elmo-folder-search-requires-msgdb-p-internal
640            folder (nth 2 condition)))
641     (and (not (string= (elmo-filter-key condition) "last"))
642          (not (string= (elmo-filter-key condition) "first")))))
643
644 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder elmo-folder)
645                                                          condition)
646   (elmo-folder-search-requires-msgdb-p-internal folder condition))
647
648 (luna-define-method elmo-folder-newsgroups ((folder elmo-folder))
649   nil)
650
651 (luna-define-method elmo-folder-open ((folder elmo-folder)
652                                       &optional load-msgdb)
653   (elmo-generic-folder-open folder load-msgdb))
654
655 (defun elmo-generic-folder-open (folder load-msgdb)
656   (let ((inhibit-quit t))
657     (if load-msgdb (elmo-folder-msgdb folder))
658     (elmo-folder-set-killed-list-internal
659      folder
660      (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder))))
661   (elmo-folder-open-internal folder))
662
663 (luna-define-method elmo-folder-open-internal ((folder elmo-folder))
664   nil ; default is do nothing.
665   )
666
667 (luna-define-method elmo-folder-check ((folder elmo-folder))
668   nil) ; default is noop.
669
670 (luna-define-method elmo-folder-commit ((folder elmo-folder))
671   (elmo-generic-folder-commit folder))
672
673 (defun elmo-generic-folder-commit (folder)
674   (when (elmo-folder-persistent-p folder)
675     (when (elmo-folder-message-modified-internal folder)
676       (elmo-msgdb-overview-save
677        (elmo-folder-msgdb-path folder)
678        (elmo-msgdb-get-overview (elmo-folder-msgdb folder)))
679       (elmo-msgdb-number-save
680        (elmo-folder-msgdb-path folder)
681        (elmo-msgdb-get-number-alist (elmo-folder-msgdb folder)))
682       (elmo-folder-set-info-max-by-numdb
683        folder
684        (elmo-msgdb-get-number-alist
685         (elmo-folder-msgdb folder)))
686       (elmo-folder-set-message-modified-internal folder nil)
687       (elmo-msgdb-killed-list-save
688        (elmo-folder-msgdb-path folder)
689        (elmo-folder-killed-list-internal folder)))
690     (when (elmo-folder-mark-modified-internal folder)
691       (elmo-msgdb-mark-save
692        (elmo-folder-msgdb-path folder)
693        (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))
694       (elmo-folder-set-mark-modified-internal folder nil))))
695
696 (luna-define-method elmo-folder-close-internal ((folder elmo-folder))
697   ;; do nothing.
698   )
699
700 (luna-define-method elmo-folder-close ((folder elmo-folder))
701   (elmo-generic-folder-close folder)
702   (elmo-folder-close-internal folder))
703
704 (defun elmo-generic-folder-close (folder)
705   (elmo-folder-commit folder)
706   (elmo-folder-set-msgdb-internal folder nil)
707   (elmo-folder-set-killed-list-internal folder nil))
708
709 (luna-define-method elmo-folder-plugged-p ((folder elmo-folder))
710   t) ; default is plugged.
711
712 (luna-define-method elmo-folder-set-plugged ((folder elmo-folder) plugged
713                                              &optional add)
714   nil) ; default is do nothing.
715
716 (luna-define-method elmo-folder-use-flag-p ((folder elmo-folder))
717   nil) ; default is no flag.
718
719 (luna-define-method elmo-folder-persistent-p ((folder elmo-folder))
720   (elmo-folder-persistent-internal folder))
721
722 (luna-define-method elmo-folder-creatable-p ((folder elmo-folder))
723   nil) ; default is not creatable.
724
725 (luna-define-method elmo-folder-writable-p ((folder elmo-folder))
726   nil) ; default is not writable.
727
728 (luna-define-method elmo-folder-delete ((folder elmo-folder))
729   (when (yes-or-no-p (format "Delete msgdb of \"%s\"? "
730                              (elmo-folder-name-internal folder)))
731     (elmo-msgdb-delete-path folder)
732     t))
733
734 (luna-define-method elmo-folder-rename ((folder elmo-folder) new-name)
735   (let* ((new-folder (elmo-make-folder new-name)))
736     (unless (eq (elmo-folder-type-internal folder)
737                 (elmo-folder-type-internal new-folder))
738       (error "Not same folder type"))
739     (if (or (file-exists-p (elmo-folder-msgdb-path new-folder))
740             (elmo-folder-exists-p new-folder))
741         (error "Already exists folder: %s" new-name))
742     (elmo-folder-send folder 'elmo-folder-rename-internal new-folder)
743     (elmo-msgdb-rename-path folder new-folder)))
744
745 (defsubst elmo-folder-search-fast (folder condition numbers)
746   "Search and return list of message numbers.
747 Return t if CONDITION is not treated.
748 FOLDER is the ELMO folder structure.
749 CONDITION is a condition structure for searching.
750 NUMBERS is a list of message numbers, messages are searched from the list."
751   (if (and numbers
752            (vectorp condition))
753       (cond
754        ((string= (elmo-filter-key condition) "flag")
755         (let ((msgdb (elmo-folder-msgdb folder)))
756           ;; msgdb should be synchronized at this point.
757           (cond
758            ((string= (elmo-filter-value condition) "unread")
759             (elmo-folder-list-unreads folder))
760            ((string= (elmo-filter-value condition) "important")
761             (elmo-folder-list-importants folder))
762            ((string= (elmo-filter-value condition) "answered")
763             (elmo-folder-list-answereds folder))
764            ((string= (elmo-filter-value condition) "digest")
765             (nconc (elmo-folder-list-unreads folder)
766                    (elmo-folder-list-importants folder)))
767            ((string= (elmo-filter-value condition) "any")
768             (nconc (elmo-folder-list-unreads folder)
769                    (elmo-folder-list-importants folder)
770                    (elmo-folder-list-answereds folder))))))
771        ((member (elmo-filter-key condition) '("first" "last"))
772         (let ((len (length numbers))
773               (lastp (string= (elmo-filter-key condition) "last"))
774               (value (string-to-number (elmo-filter-value condition))))
775           (when (eq (elmo-filter-type condition) 'unmatch)
776             (setq lastp (not lastp)
777                   value  (- len value)))
778           (if lastp
779               (nthcdr (max (- len value) 0) numbers)
780             (when (> value 0)
781               (let* ((numbers (copy-sequence numbers))
782                      (last (nthcdr (1- value) numbers)))
783                 (when last
784                   (setcdr last nil))
785                 numbers)))))
786        (t
787         t))
788     t))
789
790 (luna-define-method elmo-folder-search ((folder elmo-folder)
791                                         condition
792                                         &optional numbers)
793   (let ((numbers (or numbers (elmo-folder-list-messages folder)))
794         results)
795     (if (listp (setq results (elmo-folder-search-fast folder
796                                                       condition
797                                                       numbers)))
798         results
799       (let ((msgdb (elmo-folder-msgdb folder))
800             (len (length numbers))
801             matched)
802         (when (> len elmo-display-progress-threshold)
803           (elmo-progress-set 'elmo-folder-search len "Searching..."))
804         (unwind-protect
805             (dolist (number numbers)
806               (let (result)
807                 (setq result (elmo-msgdb-match-condition
808                               msgdb
809                               condition
810                               number
811                               numbers))
812                 (when (elmo-filter-condition-p result)
813                   (setq result (elmo-message-match-condition
814                                 folder
815                                 number
816                                 condition
817                                 numbers)))
818                 (when result
819                   (setq matched (cons number matched))))
820               (elmo-progress-notify 'elmo-folder-search))
821           (elmo-progress-clear 'elmo-folder-search))
822         (nreverse matched)))))
823
824 (luna-define-method elmo-message-match-condition ((folder elmo-folder)
825                                                   number condition
826                                                   numbers)
827   (let ((filename (cond
828                    ((elmo-message-file-name folder number))
829                    ((let* ((cache (elmo-file-cache-get
830                                    (elmo-message-field folder number
831                                                        'message-id)))
832                            (cache-path (elmo-file-cache-path cache)))
833                       (when (and cache-path
834                                  (not (elmo-cache-path-section-p cache-path)))
835                         cache-path))))))
836     (when (and filename
837                (file-readable-p filename))
838       (with-temp-buffer
839         (insert-file-contents-as-binary filename)
840         (elmo-set-buffer-multibyte default-enable-multibyte-characters)
841         ;; Should consider charset?
842         (decode-mime-charset-region (point-min) (point-max) elmo-mime-charset)
843         (elmo-buffer-field-condition-match condition number numbers)))))
844
845 (luna-define-method elmo-folder-pack-numbers ((folder elmo-folder))
846   nil) ; default is noop.
847
848 (luna-define-method elmo-folder-update-number ((folder elmo-folder))
849   nil) ; default is noop.
850
851 (luna-define-method elmo-folder-message-file-p ((folder elmo-folder))
852   nil) ; default is not file.
853
854 (luna-define-method elmo-folder-message-file-number-p ((folder elmo-folder))
855   nil) ; default is not number.
856
857 (luna-define-method elmo-folder-message-make-temp-file-p ((folder elmo-folder))
858   nil) ; default is not make temp file.
859
860 (luna-define-method elmo-message-file-name ((folder elmo-folder)
861                                                    number)
862   nil) ; default is no name.
863
864 (luna-define-method elmo-folder-local-p ((folder elmo-folder))
865   t)   ; default is local.
866
867 (luna-define-method elmo-folder-have-subfolder-p ((folder elmo-folder))
868   t)
869
870 ;;; Folder info
871 ;; Folder info is a message number information cache (hashtable)
872 (defsubst elmo-folder-get-info (folder &optional hashtb)
873   "Return FOLDER info from HASHTB (default is `elmo-folder-info-hashtb')."
874   (elmo-get-hash-val (elmo-folder-name-internal folder)
875                      (or hashtb elmo-folder-info-hashtb)))
876
877 (defun elmo-folder-set-info-hashtb (folder max numbers &optional new unread)
878   "Set FOLDER info (means MAX, NUMBERS, NEW and UNREAD)."
879   (let ((info (elmo-folder-get-info folder)))
880     (when info
881       (or new     (setq new     (nth 0 info)))
882       (or unread  (setq unread  (nth 1 info)))
883       (or numbers (setq numbers (nth 2 info)))
884       (or max     (setq max     (nth 3 info))))
885     (elmo-set-hash-val (elmo-folder-name-internal folder)
886                        (list new unread numbers max)
887                        elmo-folder-info-hashtb)))
888
889 (defun elmo-folder-set-info-max-by-numdb (folder msgdb-number)
890   "Set FOLDER info by MSGDB-NUMBER in msgdb."
891   (let ((num-db (sort (mapcar 'car msgdb-number) '<)))
892     (elmo-folder-set-info-hashtb
893      folder
894      (or (nth (max 0 (1- (length num-db))) num-db) 0)
895      nil ;;(length num-db)
896      )))
897
898 (defun elmo-folder-get-info-max (folder)
899   "Return max number of FODLER from folder info."
900   (nth 3 (elmo-folder-get-info folder)))
901
902 (defun elmo-folder-get-info-length (folder)
903   "Return length of FODLER from folder info."
904   (nth 2 (elmo-folder-get-info folder)))
905
906 (defun elmo-folder-get-info-unread (folder)
907   "Return unread of FODLER from folder info."
908   (nth 1 (elmo-folder-get-info folder)))
909
910 (defun elmo-folder-info-make-hashtb (info-alist hashtb)
911   "Setup folder info hashtable by INFO-ALIST on HASHTB."
912   (let* ((hashtb (or hashtb
913                      (elmo-make-hash (length info-alist)))))
914     (mapcar
915      (lambda (x)
916        (let ((info (cadr x)))
917          (and (intern-soft (car x) hashtb)
918               (elmo-set-hash-val (car x)
919                                  (list (nth 2 info)   ;; new
920                                        (nth 3 info)   ;; unread
921                                        (nth 1 info)   ;; length
922                                        (nth 0 info))  ;; max
923                                  hashtb))))
924      info-alist)
925     (setq elmo-folder-info-hashtb hashtb)))
926
927 (defsubst elmo-diff-new (diff)
928   (car diff))
929
930 (defsubst elmo-diff-unread (diff)
931   (when (consp (cdr diff))
932     (nth 1 diff)))
933
934 (defsubst elmo-diff-all (diff)
935   (if (consp (cdr diff))
936       (nth 2 diff)
937     (cdr diff)))
938
939 (defsubst elmo-strict-folder-diff (folder)
940   "Return folder diff information strictly from FOLDER."
941   (let* ((dir (elmo-folder-msgdb-path folder))
942          (nalist (elmo-msgdb-get-number-alist (elmo-folder-msgdb folder)))
943          (in-db (sort (mapcar 'car nalist) '<))
944          (in-folder  (elmo-folder-list-messages folder))
945          append-list delete-list diff)
946     (cons (if (equal in-folder in-db)
947               0
948             (setq diff (elmo-list-diff
949                         in-folder in-db
950                         nil
951                         ))
952             (setq append-list (car diff))
953             (setq delete-list (cadr diff))
954             (if append-list
955                 (length append-list)
956               (if delete-list
957                   (- 0 (length delete-list))
958                 0)))
959           (length in-folder))))
960
961 (luna-define-method elmo-folder-diff ((folder elmo-folder)
962                                       &optional numbers)
963   (elmo-generic-folder-diff folder numbers))
964
965 (defun elmo-generic-folder-diff (folder numbers)
966   (if (elmo-string-match-member (elmo-folder-name-internal folder)
967                                 elmo-strict-diff-folder-list)
968       (elmo-strict-folder-diff folder)
969     (let ((cached-in-db-max (elmo-folder-get-info-max folder))
970           (in-folder (elmo-folder-status folder))
971           (in-db t)
972           unsync messages
973           in-db-max)
974       (if numbers
975           (setq in-db-max (or (nth (max 0 (1- (length numbers))) numbers)
976                               0))
977         (if (not cached-in-db-max)
978             (let ((number-list (mapcar 'car
979                                        (elmo-msgdb-number-load
980                                         (elmo-folder-msgdb-path folder)))))
981               ;; No info-cache.
982               (setq in-db (sort number-list '<))
983               (setq in-db-max (or (nth (max 0 (1- (length in-db))) in-db)
984                                   0))
985               (elmo-folder-set-info-hashtb folder in-db-max nil))
986           (setq in-db-max cached-in-db-max)))
987       (setq unsync (if (and in-db (car in-folder))
988                        (- (car in-folder) in-db-max)
989                      (if (and in-folder (null in-db))
990                          (cdr in-folder)
991                        (car in-folder))))
992       (setq messages (cdr in-folder))
993       (if (and unsync messages (> unsync messages))
994           (setq unsync messages))
995       (cons (or unsync 0) (or messages 0)))))
996
997 (defvar elmo-folder-diff-async-callback nil)
998 (defvar elmo-folder-diff-async-callback-data nil)
999
1000 (luna-define-method elmo-folder-diff-async ((folder elmo-folder))
1001   (and elmo-folder-diff-async-callback
1002        (funcall elmo-folder-diff-async-callback
1003                 folder
1004                 (elmo-folder-diff folder))))
1005
1006 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-folder))
1007   (list folder))
1008
1009 (luna-define-method elmo-folder-contains-type ((folder elmo-folder) type)
1010   (eq (elmo-folder-type-internal folder) type))
1011
1012 (luna-define-method elmo-folder-append-messages ((folder elmo-folder)
1013                                                  src-folder
1014                                                  numbers
1015                                                  &optional
1016                                                  same-number)
1017   (elmo-generic-folder-append-messages folder src-folder numbers
1018                                        same-number))
1019
1020 (defun elmo-generic-folder-append-messages (folder src-folder numbers
1021                                                    same-number)
1022   (let (unseen table flag mark
1023                succeed-numbers failure cache id)
1024     (setq table (elmo-flag-table-load (elmo-folder-msgdb-path folder)))
1025     (with-temp-buffer
1026       (set-buffer-multibyte nil)
1027       (while numbers
1028         (setq failure nil
1029               id (elmo-message-field src-folder (car numbers) 'message-id)
1030               mark (elmo-message-mark src-folder (car numbers))
1031               flag (and id
1032                         (cond
1033                          ((null mark) 'read)
1034                          ((member mark (elmo-msgdb-answered-marks))
1035                           'answered)
1036                          ;;
1037                          ((not (member mark (elmo-msgdb-unread-marks)))
1038                           'read))))
1039         (condition-case nil
1040             (setq cache (elmo-file-cache-get id)
1041                   failure
1042                   (not
1043                    (and
1044                     (elmo-message-fetch
1045                      src-folder (car numbers)
1046                      (if (elmo-folder-plugged-p src-folder)
1047                          (elmo-make-fetch-strategy
1048                           'entire 'maybe nil
1049                           (and cache (elmo-file-cache-path cache)))
1050                        (or (and elmo-enable-disconnected-operation
1051                                 cache
1052                                 (eq (elmo-file-cache-status cache) 'entire)
1053                                 (elmo-make-fetch-strategy
1054                                  'entire t nil
1055                                  (elmo-file-cache-path cache)))
1056                            (error "Unplugged")))
1057                      nil (current-buffer)
1058                      'unread)
1059                     (> (buffer-size) 0)
1060                     (elmo-folder-append-buffer
1061                      folder
1062                      flag
1063                      (if same-number (car numbers))))))
1064           (error (setq failure t)))
1065         ;; FETCH & APPEND finished
1066         (unless failure
1067           (when id
1068             (elmo-flag-table-set table id flag))
1069           (setq succeed-numbers (cons (car numbers) succeed-numbers)))
1070         (elmo-progress-notify 'elmo-folder-move-messages)
1071         (setq numbers (cdr numbers)))
1072       (when (elmo-folder-persistent-p folder)
1073         (elmo-flag-table-save (elmo-folder-msgdb-path folder) table))
1074       succeed-numbers)))
1075
1076 ;; Arguments should be reduced.
1077 (defun elmo-folder-move-messages (src-folder msgs dst-folder
1078                                              &optional msgdb
1079                                              no-delete-info
1080                                              no-delete
1081                                              same-number
1082                                              save-unread)
1083   (save-excursion
1084     (let* ((messages msgs)
1085            (elmo-inhibit-display-retrieval-progress t)
1086            (len (length msgs))
1087            succeeds i result)
1088       (if (eq dst-folder 'null)
1089           (setq succeeds messages)
1090         (unless (elmo-folder-writable-p dst-folder)
1091           (error "move: %d is not writable"
1092                  (elmo-folder-name-internal dst-folder)))
1093         (when messages
1094           ;; src is already opened.
1095           (elmo-folder-open-internal dst-folder)
1096           (unless (setq succeeds (elmo-folder-append-messages dst-folder
1097                                                               src-folder
1098                                                               messages
1099                                                               same-number))
1100             (error "move: append message to %s failed"
1101                    (elmo-folder-name-internal dst-folder)))
1102           (elmo-folder-close dst-folder)))
1103       (if (and (not no-delete) succeeds)
1104           (progn
1105             (if (and (elmo-folder-delete-messages src-folder succeeds)
1106                      (elmo-folder-detach-messages src-folder succeeds))
1107                 (setq result t)
1108               (message "move: delete messages from %s failed."
1109                        (elmo-folder-name-internal src-folder))
1110               (setq result nil))
1111             result)
1112         (if no-delete
1113             (progn
1114               ;; (message "Copying messages...done")
1115               t)
1116           (if (eq len 0)
1117               (message "No message was moved.")
1118             (message "Moving messages failed.")
1119             nil ; failure
1120             ))))))
1121
1122 (defun elmo-folder-msgdb-path (folder)
1123   "Return the msgdb path for FOLDER."
1124   (or (elmo-folder-path-internal folder)
1125       (elmo-folder-set-path-internal
1126        folder
1127        (elmo-folder-expand-msgdb-path folder))))
1128
1129 (defun elmo-message-accessible-p (folder number)
1130   "Get accessibility of the message.
1131 Return non-nil when message is accessible."
1132   (or (elmo-folder-plugged-p folder)
1133       (elmo-folder-local-p folder)
1134       (elmo-msgdb-get-cached (elmo-folder-msgdb folder) number)))
1135
1136 (defun elmo-message-set-cached (folder number cached)
1137   "Set cache status of the message in the msgdb.
1138 FOLDER is the ELMO folder structure.
1139 NUMBER is a number of the message.
1140 If CACHED is t, message is set as cached."
1141   (when (elmo-msgdb-set-cached (elmo-folder-msgdb folder)
1142                                number
1143                                cached
1144                                (elmo-message-use-cache-p folder number))
1145     (elmo-folder-set-mark-modified-internal folder t)))
1146
1147 (defun elmo-message-copy-entity (entity)
1148   ;; 
1149   (elmo-msgdb-copy-overview-entity entity))
1150
1151 (defun elmo-message-entity-set-number (entity number)
1152   (elmo-msgdb-overview-entity-set-number entity number))
1153
1154 (luna-define-generic elmo-message-entity (folder key)
1155   "Return the message-entity structure which matches to the KEY.
1156 KEY is a number or a string.
1157 A number is for message number in the FOLDER.
1158 A string is for message-id of the message.")
1159
1160 (luna-define-method elmo-message-entity ((folder elmo-folder) key)
1161   (elmo-msgdb-message-entity (elmo-folder-msgdb folder) key))
1162
1163 (luna-define-generic elmo-message-entity-parent (folder entity)
1164   "Return the parent message-entity structure in the FOLDER.
1165 ENTITY is the message-entity to get the parent.")
1166
1167 (luna-define-method elmo-message-entity-parent ((folder elmo-folder) entity)
1168   (elmo-msgdb-get-parent-entity entity (elmo-folder-msgdb folder)))
1169
1170 (put 'elmo-folder-do-each-message-entity 'lisp-indent-function '1)
1171 (def-edebug-spec elmo-folder-do-each-message-entity
1172   ((symbolp form &rest form) &rest form))
1173
1174 (defsubst elmo-folder-list-message-entities (folder)
1175   ;; List all message entities in the FOLDER.
1176   (mapcar
1177    (lambda (number) (elmo-message-entity folder number))
1178    (elmo-folder-list-messages folder t t)))
1179
1180 (defmacro elmo-folder-do-each-message-entity (spec &rest form)
1181   "Iterator for message entity in the folder.
1182 \(elmo-folder-do-each-message-entity \(entity folder\)
1183  ... do the process using entity...
1184 \)"
1185   `(dolist (,(car spec) (elmo-folder-list-message-entities ,(car (cdr spec))))
1186      ,@form))
1187
1188 (defmacro elmo-message-entity-number (entity)
1189   `(elmo-msgdb-overview-entity-get-number ,entity))
1190
1191 (defun elmo-message-entity-field (entity field &optional decode)
1192   "Get message entity field value.
1193 ENTITY is the message entity structure obtained by `elmo-message-entity'.
1194 FIELD is the symbol of the field name.
1195 if optional DECODE is non-nil, returned value is decoded."
1196   (elmo-msgdb-message-entity-field entity field decode))
1197
1198 (defun elmo-message-entity-set-field (entity field value)
1199   "Set message entity field value.
1200 ENTITY is the message entity structure.
1201 FIELD is the symbol of the field name.
1202 VALUE is the field value (raw)."
1203   (elmo-msgdb-message-entity-set-field entity field value))
1204
1205 (luna-define-generic elmo-folder-count-flags (folder)
1206   "Count flagged message number in the msgdb of the FOLDER.
1207 Return a list of numbers (`new' `unread' `answered')")
1208
1209 (luna-define-method elmo-folder-count-flags ((folder elmo-folder))
1210   (let ((new 0)
1211         (unreads 0)
1212         (answered 0))
1213     (dolist (elem (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))
1214       (cond
1215        ((string= (cadr elem) elmo-msgdb-new-mark)
1216         (incf new))
1217        ((member (cadr elem) (elmo-msgdb-unread-marks))
1218         (incf unreads))
1219        ((member (cadr elem) (elmo-msgdb-answered-marks))
1220         (incf answered))))
1221     (list new unreads answered)))
1222
1223 (defun elmo-message-set-flag (folder number flag)
1224   "Set message flag.
1225 FOLDER is a ELMO folder structure.
1226 NUMBER is a message number to set flag.
1227
1228 FLAG is a symbol which is one of the following:
1229   `unread'    (set the message as unread)
1230   `answered'  (set the message as answered)
1231   `important' (set the message as important)
1232 'sugar' flag:
1233   `read'      (remove new and unread flags)")
1234
1235 (defun elmo-message-unset-flag (folder number flag)
1236   "Unset message flag.
1237 FOLDER is a ELMO folder structure.
1238 NUMBER is a message number to set flag.
1239
1240 FLAG is a symbol which is one of the following:
1241   `unread'    (remove unread and new flag)
1242   `answered'  (remove answered flag)
1243   `important' (remove important flag)
1244 'sugar' flag:
1245   `read'      (set unread flag)")
1246
1247 (luna-define-generic elmo-message-mark (folder number)
1248   "Get mark of the message.
1249 FOLDER is the ELMO folder structure.
1250 NUMBER is a number of the message.")
1251
1252 (luna-define-method elmo-message-mark ((folder elmo-folder) number)
1253   (when (zerop (elmo-folder-length folder))
1254     (error "Cannot treat this folder correctly."))
1255   (elmo-msgdb-get-mark (elmo-folder-msgdb folder) number))
1256
1257 (luna-define-generic elmo-message-field (folder number field)
1258   "Get message field value in the msgdb.
1259 FOLDER is the ELMO folder structure.
1260 NUMBER is a number of the message.
1261 FIELD is a symbol of the field.")
1262
1263 (luna-define-method elmo-message-field ((folder elmo-folder) number field)
1264   (when (zerop (elmo-folder-length folder))
1265     (error "Cannot treat this folder correctly."))
1266   (elmo-msgdb-get-field (elmo-folder-msgdb folder) number field))
1267
1268 (luna-define-method elmo-message-use-cache-p ((folder elmo-folder) number)
1269   nil) ; default is not use cache.
1270
1271 (luna-define-method elmo-message-folder ((folder elmo-folder) number)
1272   folder) ; default is folder
1273
1274 (luna-define-method elmo-folder-unmark-important ((folder elmo-folder)
1275                                                   numbers
1276                                                   &optional ignore-flags)
1277   (when (elmo-folder-msgdb-internal folder)
1278     (dolist (number numbers)
1279       (elmo-msgdb-unset-flag (elmo-folder-msgdb folder)
1280                              folder
1281                              number
1282                              'important))))
1283
1284 (luna-define-method elmo-folder-mark-as-important ((folder elmo-folder)
1285                                                    numbers
1286                                                    &optional ignore-flags)
1287   (when (elmo-folder-msgdb-internal folder)
1288     (dolist (number numbers)
1289       (elmo-msgdb-set-flag (elmo-folder-msgdb folder)
1290                            folder
1291                            number
1292                            'important))))
1293
1294 (luna-define-method elmo-folder-unmark-read ((folder elmo-folder)
1295                                              numbers
1296                                              &optional ignore-flags)
1297   (when (elmo-folder-msgdb-internal folder)
1298     (dolist (number numbers)
1299       (elmo-msgdb-unset-flag (elmo-folder-msgdb folder)
1300                              folder
1301                              number
1302                              'read))))
1303
1304 (luna-define-method elmo-folder-mark-as-read ((folder elmo-folder)
1305                                               numbers
1306                                               &optional ignore-flag)
1307   (when (elmo-folder-msgdb-internal folder)
1308     (dolist (number numbers)
1309       (elmo-msgdb-set-flag (elmo-folder-msgdb folder)
1310                            folder
1311                            number
1312                            'read))))
1313
1314 (luna-define-method elmo-folder-unmark-answered ((folder elmo-folder) numbers)
1315   (when (elmo-folder-msgdb-internal folder)
1316     (dolist (number numbers)
1317       (elmo-msgdb-unset-flag (elmo-folder-msgdb folder)
1318                              folder
1319                              number
1320                              'answered))))
1321
1322 (luna-define-method elmo-folder-mark-as-answered ((folder elmo-folder) numbers)
1323   (when (elmo-folder-msgdb-internal folder)
1324     (dolist (number numbers)
1325       (elmo-msgdb-set-flag (elmo-folder-msgdb folder)
1326                            folder
1327                            number
1328                            'answered))))
1329
1330 (luna-define-method elmo-folder-process-crosspost ((folder elmo-folder))
1331   ;; Do nothing.
1332   )
1333
1334 ;;(luna-define-generic elmo-folder-append-message-entity (folder entity
1335 ;;                                                             &optional
1336 ;;                                                             flag-table)
1337 ;;  "Append ENTITY to the folder.")
1338
1339 (defun elmo-generic-folder-append-msgdb (folder append-msgdb)
1340   (if append-msgdb
1341       (let* ((number-alist (elmo-msgdb-get-number-alist append-msgdb))
1342              (all-alist (copy-sequence (append
1343                                         (elmo-msgdb-get-number-alist
1344                                          (elmo-folder-msgdb folder))
1345                                         number-alist)))
1346              (cur number-alist)
1347              pair overview
1348              to-be-deleted
1349              mark-alist)
1350         (elmo-folder-set-msgdb-internal folder
1351                                         (elmo-msgdb-append
1352                                          (elmo-folder-msgdb folder)
1353                                          append-msgdb))
1354         (while cur
1355           (setq all-alist (delq (car cur) all-alist))
1356           ;; same message id exists.
1357           (if (setq pair (rassoc (cdr (car cur)) all-alist))
1358               (setq to-be-deleted (nconc to-be-deleted (list (car pair)))))
1359           (setq cur (cdr cur)))
1360         (cond ((eq (elmo-folder-process-duplicates-internal folder)
1361                    'hide)
1362                ;; Hide duplicates.
1363                (setq overview (elmo-delete-if
1364                                (lambda (x)
1365                                  (memq (elmo-msgdb-overview-entity-get-number
1366                                         x)
1367                                        to-be-deleted))
1368                                (elmo-msgdb-get-overview append-msgdb)))
1369                ;; Should be mark as read.
1370                (elmo-folder-mark-as-read folder to-be-deleted)
1371                (elmo-msgdb-set-overview append-msgdb overview))
1372               ((eq (elmo-folder-process-duplicates-internal folder)
1373                    'read)
1374                ;; Mark as read duplicates.
1375                (elmo-folder-mark-as-read folder to-be-deleted))
1376               (t
1377                ;; Do nothing.
1378                (setq to-be-deleted nil)))
1379         (length to-be-deleted))
1380     0))
1381
1382 (luna-define-method elmo-folder-append-msgdb ((folder elmo-folder)
1383                                               append-msgdb)
1384   (elmo-generic-folder-append-msgdb folder append-msgdb))
1385
1386 (defun elmo-folder-confirm-appends (appends)
1387   (let ((len (length appends))
1388         in)
1389     (if (and elmo-folder-update-threshold
1390              (> len elmo-folder-update-threshold)
1391              elmo-folder-update-confirm)
1392         (if (y-or-n-p (format "Too many messages(%d).  Update all? " len))
1393             appends
1394           (setq in elmo-folder-update-threshold)
1395           (catch 'end
1396             (while t
1397               (setq in (read-from-minibuffer "Update number: "
1398                                              (int-to-string in))
1399                     in (string-to-int in))
1400               (if (< len in)
1401                   (throw 'end len))
1402               (if (y-or-n-p (format "%d messages are not appeared.  OK? "
1403                                     (max (- len in) 0)))
1404                   (throw 'end in))))
1405           (nthcdr (max (- len in) 0) appends))
1406       (if (and elmo-folder-update-threshold
1407                (> len elmo-folder-update-threshold)
1408                (not elmo-folder-update-confirm))
1409           (nthcdr (max (- len elmo-folder-update-threshold) 0) appends)
1410         appends))))
1411
1412 (luna-define-method elmo-message-fetch ((folder elmo-folder)
1413                                         number strategy
1414                                         &optional
1415                                         section
1416                                         outbuf
1417                                         unread)
1418   (if outbuf
1419       (with-current-buffer outbuf
1420         (erase-buffer)
1421         (elmo-message-fetch-with-cache-process folder number
1422                                                strategy section unread))
1423     (with-temp-buffer
1424       (elmo-message-fetch-with-cache-process folder number
1425                                              strategy section unread)
1426       (buffer-string))))
1427
1428 (luna-define-method elmo-message-fetch-with-cache-process ((folder elmo-folder)
1429                                                            number strategy
1430                                                            &optional
1431                                                            section unread)
1432   (let ((cache-path (elmo-fetch-strategy-cache-path strategy))
1433         (method-priorities
1434          (cond ((eq (elmo-fetch-strategy-use-cache strategy) 'maybe)
1435                 '(entity cache))
1436                ((elmo-fetch-strategy-use-cache strategy)
1437                 '(cache entity))
1438                (t
1439                 '(entity))))
1440         result err)
1441     (while (and method-priorities
1442                 (null result))
1443       (setq result
1444             (case (car method-priorities)
1445               (cache
1446                (elmo-file-cache-load cache-path section))
1447               (entity
1448                (when (and (condition-case error
1449                               (elmo-message-fetch-internal folder number
1450                                                            strategy
1451                                                            section
1452                                                            unread)
1453                             (error (setq err error) nil))
1454                           (> (buffer-size) 0))
1455                  (elmo-delete-cr-buffer)
1456                  (when (and (elmo-fetch-strategy-save-cache strategy)
1457                             cache-path)
1458                    (elmo-file-cache-save cache-path section))
1459                  t)))
1460             method-priorities (cdr method-priorities)))
1461     (or result
1462         (and err (signal (car err) (cdr err))))))
1463
1464 (defun elmo-folder-kill-messages-before (folder msg)
1465   (elmo-folder-set-killed-list-internal
1466    folder
1467    (list (cons 1 msg))))
1468
1469 (defun elmo-folder-kill-messages (folder numbers)
1470   "Kill(hide) messages in the FOLDER with NUMBERS."
1471   (elmo-folder-set-killed-list-internal
1472    folder
1473    (elmo-number-set-append-list (elmo-folder-killed-list-internal
1474                                  folder) numbers)))
1475
1476
1477 (luna-define-method elmo-folder-clear ((folder elmo-folder)
1478                                        &optional keep-killed)
1479   (unless keep-killed
1480     (elmo-folder-set-killed-list-internal folder nil))
1481   (elmo-folder-set-msgdb-internal folder (elmo-msgdb-clear)))
1482
1483 (luna-define-generic elmo-folder-synchronize (folder
1484                                               &optional ignore-msgdb
1485                                               no-check)
1486   "Synchronize the folder data to the newest status.
1487 FOLDER is the ELMO folder structure.
1488
1489 If optional IGNORE-MSGDB is non-nil, current msgdb is thrown away except
1490 flag status. If IGNORE-MSGDB is 'visible-only, only visible messages
1491 \(the messages which are not in the killed-list\) are thrown away and
1492 synchronized.
1493 If NO-CHECK is non-nil, rechecking folder is skipped.
1494 Return a list of a cross-posted message number.
1495 If update process is interrupted, return nil.")
1496
1497 (luna-define-method elmo-folder-synchronize ((folder elmo-folder)
1498                                              &optional ignore-msgdb no-check)
1499   (let ((killed-list (elmo-folder-killed-list-internal folder))
1500         (before-append t)
1501         number-alist
1502         old-msgdb diff diff-2 delete-list new-list new-msgdb mark
1503         flag-table crossed after-append numbers)
1504     (setq old-msgdb (elmo-folder-msgdb folder))
1505     (setq flag-table (elmo-flag-table-load (elmo-folder-msgdb-path folder)))
1506     (when ignore-msgdb
1507       (elmo-msgdb-flag-table (elmo-folder-msgdb folder) flag-table)
1508       (elmo-folder-clear folder (eq ignore-msgdb 'visible-only)))
1509     (setq numbers (sort (elmo-folder-list-messages folder nil t) '<))
1510     (unless no-check (elmo-folder-check folder))
1511     (condition-case nil
1512         (progn
1513           (message "Checking folder diff...")
1514           (setq diff (elmo-list-diff (elmo-folder-list-messages
1515                                       folder
1516                                       (eq 'visible-only ignore-msgdb))
1517                                      numbers))
1518           (message "Checking folder diff...done")
1519           (setq new-list (elmo-folder-confirm-appends (car diff)))
1520           ;; Set killed list as ((1 . MAX-OF-DISAPPEARED))
1521           (when (and (not (eq (length (car diff))
1522                               (length new-list)))
1523                      (setq diff-2 (elmo-list-diff (car diff) new-list)))
1524             (elmo-folder-kill-messages-before folder
1525                                               (nth (- (length (car diff-2)) 1)
1526                                                    (car diff-2))))
1527           (setq delete-list (cadr diff))
1528           (if (or (equal diff '(nil nil))
1529                   (equal diff '(nil))
1530                   (and (eq (length (car diff)) 0)
1531                        (eq (length (cadr diff)) 0)))
1532               (progn
1533                 (elmo-folder-update-number folder)
1534                 (elmo-folder-process-crosspost folder)
1535                 0 ; no updates.
1536                 )
1537             (when delete-list
1538               (elmo-folder-detach-messages folder delete-list))
1539             (when new-list
1540               (elmo-msgdb-change-mark (elmo-folder-msgdb folder)
1541                                       elmo-msgdb-new-mark
1542                                       elmo-msgdb-unread-uncached-mark)
1543               (setq new-msgdb (elmo-folder-msgdb-create
1544                                folder new-list flag-table))
1545               ;; Clear flag-table
1546               (if (elmo-folder-persistent-p folder)
1547                   (elmo-flag-table-save (elmo-folder-msgdb-path folder)
1548                                         nil))
1549               (setq before-append nil)
1550               (setq crossed (elmo-folder-append-msgdb folder new-msgdb))
1551               ;; process crosspost.
1552               ;; Return a cons cell of (NUMBER-CROSSPOSTS . NEW-MARK-ALIST).
1553               (elmo-folder-process-crosspost folder)
1554               (elmo-folder-set-message-modified-internal folder t)
1555               (elmo-folder-set-mark-modified-internal folder t))
1556             ;; return value.
1557             (or crossed 0)))
1558       (quit
1559        ;; Resume to the original status.
1560        (if before-append (elmo-folder-set-msgdb-internal folder old-msgdb))
1561        (elmo-folder-set-killed-list-internal folder killed-list)
1562        nil))))
1563
1564 (luna-define-generic elmo-folder-detach-messages (folder numbers)
1565   "Remove messages with NUMBERS from MSGDB.")
1566
1567 (luna-define-method elmo-folder-detach-messages ((folder elmo-folder)
1568                                                  numbers)
1569   (elmo-msgdb-delete-msgs (elmo-folder-msgdb folder) numbers))
1570
1571 (luna-define-generic elmo-folder-length (folder)
1572   "Return number of messages in the FOLDER.")
1573
1574 (luna-define-method elmo-folder-length ((folder elmo-folder))
1575   (elmo-msgdb-length (elmo-folder-msgdb folder)))
1576
1577 (defun elmo-msgdb-load (folder &optional silent)
1578   (unless silent
1579     (message "Loading msgdb for %s..." (elmo-folder-name-internal folder)))
1580   (let ((msgdb (elmo-load-msgdb (elmo-folder-msgdb-path folder))))
1581     (elmo-folder-set-info-max-by-numdb folder
1582                                        (elmo-msgdb-get-number-alist msgdb))
1583
1584     (unless silent
1585       (message "Loading msgdb for %s...done"
1586                (elmo-folder-name-internal folder)))
1587     msgdb))
1588
1589 (defun elmo-msgdb-delete-path (folder)
1590   (let ((path (elmo-folder-msgdb-path folder)))
1591     (if (file-directory-p path)
1592         (elmo-delete-directory path t))))
1593
1594 (defun elmo-msgdb-rename-path (old-folder new-folder)
1595   (let* ((old (directory-file-name (elmo-folder-msgdb-path old-folder)))
1596          (new (directory-file-name (elmo-folder-msgdb-path new-folder)))
1597          (new-dir (directory-file-name (file-name-directory new))))
1598     (if (not (file-directory-p old))
1599         ()
1600       (if (file-exists-p new)
1601           (error "Already exists directory: %s" new)
1602         (if (not (file-exists-p new-dir))
1603             (elmo-make-directory new-dir))
1604         (rename-file old new)))))
1605
1606 (defun elmo-setup-subscribed-newsgroups (groups)
1607   "Setup subscribed newsgroups.
1608 GROUPS is a list of newsgroup name string.
1609 Return a hashtable for newsgroups."
1610   (let ((hashtb (or elmo-newsgroups-hashtb
1611                     (setq elmo-newsgroups-hashtb
1612                           (elmo-make-hash (length groups))))))
1613     (dolist (group groups)
1614       (or (elmo-get-hash-val group hashtb)
1615           (elmo-set-hash-val group nil hashtb)))
1616     (setq elmo-newsgroups-hashtb hashtb)))
1617
1618 (defvar elmo-crosspost-message-alist-modified nil)
1619 (defun elmo-crosspost-message-alist-load ()
1620   "Load crosspost message alist."
1621   (setq elmo-crosspost-message-alist (elmo-crosspost-alist-load))
1622   (setq elmo-crosspost-message-alist-modified nil))
1623
1624 (defun elmo-crosspost-message-alist-save ()
1625   "Save crosspost message alist."
1626   (when elmo-crosspost-message-alist-modified
1627     (let ((alist elmo-crosspost-message-alist)
1628           newsgroups)
1629       (while alist
1630         (setq newsgroups
1631               (elmo-delete-if
1632                '(lambda (x)
1633                   (not (intern-soft x elmo-newsgroups-hashtb)))
1634                (nth 1 (car alist))))
1635         (if newsgroups
1636             (setcar (cdar alist) newsgroups)
1637           (setq elmo-crosspost-message-alist
1638                 (delete (car alist) elmo-crosspost-message-alist)))
1639         (setq alist (cdr alist)))
1640       (elmo-crosspost-alist-save elmo-crosspost-message-alist)
1641       (setq elmo-crosspost-message-alist-modified nil))))
1642
1643 (defun elmo-folder-make-temporary-directory (folder)
1644   ;; Make a temporary directory for FOLDER.
1645   (let ((temp-dir (make-temp-name
1646                    (concat
1647                     (file-name-as-directory (elmo-folder-msgdb-path folder))
1648                     "elmo"))))
1649     (elmo-make-directory temp-dir)
1650     temp-dir))
1651
1652 (defun elmo-init ()
1653   "Initialize ELMO module."
1654   (elmo-crosspost-message-alist-load)
1655   (elmo-resque-obsolete-variables)
1656   (elmo-dop-queue-load))
1657
1658 (defun elmo-quit ()
1659   "Quit and cleanup ELMO."
1660   (elmo-crosspost-message-alist-save)
1661   (elmo-dop-queue-save)
1662   ;; Not implemented yet.
1663   (let ((types elmo-folder-type-alist)
1664         class)
1665     (while types
1666       (setq class
1667             (luna-find-class
1668              (intern (format "elmo-%s-folder" (symbol-name (cdr (car types)))))))
1669       ;; Call all folder's `elmo-quit' method.
1670       (if class
1671           (dolist (func (luna-class-find-functions class 'elmo-quit))
1672             (funcall func nil)))
1673       (setq types (cdr types)))))
1674
1675 (luna-define-method elmo-folder-rename-internal ((folder elmo-folder)
1676                                                  new-folder)
1677   (error "Cannot rename %s folder"
1678          (symbol-name (elmo-folder-type-internal folder))))
1679
1680
1681 ;;; Define folders.
1682 (elmo-define-folder ?% 'imap4)
1683 (elmo-define-folder ?-  'nntp)
1684 (elmo-define-folder ?\+ 'localdir)
1685 (elmo-define-folder ?\* 'multi)
1686 (elmo-define-folder ?\/ 'filter)
1687 (elmo-define-folder ?\$ 'archive)
1688 (elmo-define-folder ?&  'pop3)
1689 (elmo-define-folder ?=  'localnews)
1690 (elmo-define-folder ?|  'pipe)
1691 (elmo-define-folder ?.  'maildir)
1692 (elmo-define-folder ?'  'internal)
1693 (elmo-define-folder ?\[  'nmz)
1694 (elmo-define-folder ?@  'shimbun)
1695
1696 ;;; Obsolete variables.
1697 (elmo-define-obsolete-variable 'elmo-default-imap4-mailbox
1698                                'elmo-imap4-default-mailbox)
1699 (elmo-define-obsolete-variable 'elmo-default-imap4-server
1700                                'elmo-imap4-default-server)
1701 (elmo-define-obsolete-variable 'elmo-default-imap4-authenticate-type
1702                                'elmo-imap4-default-authenticate-type)
1703 (elmo-define-obsolete-variable 'elmo-default-imap4-user
1704                                'elmo-imap4-default-user)
1705 (elmo-define-obsolete-variable 'elmo-default-imap4-port
1706                                'elmo-imap4-default-port)
1707 (elmo-define-obsolete-variable 'elmo-default-imap4-stream-type
1708                                'elmo-imap4-default-stream-type)
1709 (elmo-define-obsolete-variable 'elmo-default-nntp-server
1710                                'elmo-nntp-default-server)
1711 (elmo-define-obsolete-variable 'elmo-default-nntp-user
1712                                'elmo-nntp-default-user)
1713 (elmo-define-obsolete-variable 'elmo-default-nntp-port
1714                                'elmo-nntp-default-port)
1715 (elmo-define-obsolete-variable 'elmo-default-nntp-stream-type
1716                                'elmo-nntp-default-stream-type)
1717 (elmo-define-obsolete-variable 'elmo-default-pop3-server
1718                                'elmo-pop3-default-server)
1719 (elmo-define-obsolete-variable 'elmo-default-pop3-user
1720                                'elmo-pop3-default-user)
1721 (elmo-define-obsolete-variable 'elmo-default-pop3-authenticate-type
1722                                'elmo-pop3-default-authenticate-type)
1723 (elmo-define-obsolete-variable 'elmo-default-pop3-port
1724                                'elmo-pop3-default-port)
1725 (elmo-define-obsolete-variable 'elmo-default-pop3-stream-type
1726                                'elmo-pop3-default-stream-type)
1727 (elmo-define-obsolete-variable 'elmo-cache-dirname
1728                                'elmo-cache-directory)
1729 (elmo-define-obsolete-variable 'elmo-msgdb-dir
1730                                'elmo-msgdb-directory)
1731
1732 ;; Obsolete functions.
1733 ;; 2001-12-11: *-dir -> *-directory
1734 (defalias 'elmo-folder-make-temp-dir 'elmo-folder-make-temporary-directory)
1735 (make-obsolete 'elmo-folder-make-temp-dir
1736                'elmo-folder-make-temporary-directory)
1737
1738
1739 ;; autoloads
1740 (autoload 'elmo-dop-queue-flush "elmo-dop")
1741 (autoload 'elmo-nntp-post "elmo-nntp")
1742
1743 (require 'product)
1744 (product-provide (provide 'elmo) (require 'elmo-version))
1745
1746 ;;; elmo.el ends here