* elmo.el (elmo-folder-list-unreads): Don't use msgdb API.
[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   (when (and numbers
747              (vectorp condition)
748              (member (elmo-filter-key condition) '("first" "last" "mark")))
749     (if (string= (elmo-filter-key condition) "flag")
750         (let ((msgdb (elmo-folder-msgdb folder)))
751           ;; msgdb should be synchronized at this point.
752           (cond
753            ((string= (elmo-filter-value condition) "unread")
754             (elmo-folder-list-unreads folder))
755            ((string= (elmo-filter-value condition) "important")
756             (elmo-folder-list-importants folder))
757            ((string= (elmo-filter-value condition) "answered")
758             (elmo-folder-list-answereds folder))
759            ((string= (elmo-filter-value condition) "digest")
760             (nconc (elmo-folder-list-unreads folder)
761                    (elmo-folder-list-importants folder)))
762            ((string= (elmo-filter-value condition) "any")
763             (nconc (elmo-folder-list-unreads folder)
764                    (elmo-folder-list-importants folder)
765                    (elmo-folder-list-answereds folder)))))
766       (let ((len (length numbers))
767             (lastp (string= (elmo-filter-key condition) "last"))
768             (value (string-to-number (elmo-filter-value condition))))
769         (when (eq (elmo-filter-type condition) 'unmatch)
770           (setq lastp (not lastp)
771                 value  (- len value)))
772         (if lastp
773             (nthcdr (max (- len value) 0) numbers)
774           (when (> value 0)
775             (let ((last (nthcdr (1- value) numbers)))
776               (when last
777                 (setcdr last nil))
778               numbers)))))))
779
780 (luna-define-method elmo-folder-search ((folder elmo-folder)
781                                         condition
782                                         &optional numbers)
783   (let ((numbers (or numbers (elmo-folder-list-messages folder))))
784     (or (elmo-folder-search-fast folder condition numbers)
785         (let ((msgdb (elmo-folder-msgdb folder))
786               (len (length numbers))
787               matched)
788           (when (> len elmo-display-progress-threshold)
789             (elmo-progress-set 'elmo-folder-search len "Searching..."))
790           (unwind-protect
791               (dolist (number numbers)
792                 (let (result)
793                   (setq result (elmo-msgdb-match-condition
794                                 msgdb
795                                 condition
796                                 number
797                                 numbers))
798                   (when (elmo-filter-condition-p result)
799                     (setq result (elmo-message-match-condition
800                                   folder
801                                   number
802                                   condition
803                                   numbers)))
804                   (when result
805                     (setq matched (cons number matched))))
806                 (elmo-progress-notify 'elmo-folder-search))
807             (elmo-progress-clear 'elmo-folder-search))
808           (nreverse matched)))))
809
810 (luna-define-method elmo-message-match-condition ((folder elmo-folder)
811                                                   number condition
812                                                   numbers)
813   (let ((filename (cond
814                    ((elmo-message-file-name folder number))
815                    ((let* ((cache (elmo-file-cache-get
816                                    (elmo-message-field folder number
817                                                        'message-id)))
818                            (cache-path (elmo-file-cache-path cache)))
819                       (when (and cache-path
820                                  (not (elmo-cache-path-section-p cache-path)))
821                         cache-path))))))
822     (when (and filename
823                (file-readable-p filename))
824       (with-temp-buffer
825         (insert-file-contents-as-binary filename)
826         (elmo-set-buffer-multibyte default-enable-multibyte-characters)
827         ;; Should consider charset?
828         (decode-mime-charset-region (point-min) (point-max) elmo-mime-charset)
829         (elmo-buffer-field-condition-match condition number numbers)))))
830
831 (luna-define-method elmo-folder-pack-numbers ((folder elmo-folder))
832   nil) ; default is noop.
833
834 (luna-define-method elmo-folder-update-number ((folder elmo-folder))
835   nil) ; default is noop.
836
837 (luna-define-method elmo-folder-message-file-p ((folder elmo-folder))
838   nil) ; default is not file.
839
840 (luna-define-method elmo-folder-message-file-number-p ((folder elmo-folder))
841   nil) ; default is not number.
842
843 (luna-define-method elmo-folder-message-make-temp-file-p ((folder elmo-folder))
844   nil) ; default is not make temp file.
845
846 (luna-define-method elmo-message-file-name ((folder elmo-folder)
847                                                    number)
848   nil) ; default is no name.
849
850 (luna-define-method elmo-folder-local-p ((folder elmo-folder))
851   t)   ; default is local.
852
853 (luna-define-method elmo-folder-have-subfolder-p ((folder elmo-folder))
854   t)
855
856 ;;; Folder info
857 ;; Folder info is a message number information cache (hashtable)
858 (defsubst elmo-folder-get-info (folder &optional hashtb)
859   "Return FOLDER info from HASHTB (default is `elmo-folder-info-hashtb')."
860   (elmo-get-hash-val (elmo-folder-name-internal folder)
861                      (or hashtb elmo-folder-info-hashtb)))
862
863 (defun elmo-folder-set-info-hashtb (folder max numbers &optional new unread)
864   "Set FOLDER info (means MAX, NUMBERS, NEW and UNREAD)."
865   (let ((info (elmo-folder-get-info folder)))
866     (when info
867       (or new     (setq new     (nth 0 info)))
868       (or unread  (setq unread  (nth 1 info)))
869       (or numbers (setq numbers (nth 2 info)))
870       (or max     (setq max     (nth 3 info))))
871     (elmo-set-hash-val (elmo-folder-name-internal folder)
872                        (list new unread numbers max)
873                        elmo-folder-info-hashtb)))
874
875 (defun elmo-folder-set-info-max-by-numdb (folder msgdb-number)
876   "Set FOLDER info by MSGDB-NUMBER in msgdb."
877   (let ((num-db (sort (mapcar 'car msgdb-number) '<)))
878     (elmo-folder-set-info-hashtb
879      folder
880      (or (nth (max 0 (1- (length num-db))) num-db) 0)
881      nil ;;(length num-db)
882      )))
883
884 (defun elmo-folder-get-info-max (folder)
885   "Return max number of FODLER from folder info."
886   (nth 3 (elmo-folder-get-info folder)))
887
888 (defun elmo-folder-get-info-length (folder)
889   "Return length of FODLER from folder info."
890   (nth 2 (elmo-folder-get-info folder)))
891
892 (defun elmo-folder-get-info-unread (folder)
893   "Return unread of FODLER from folder info."
894   (nth 1 (elmo-folder-get-info folder)))
895
896 (defun elmo-folder-info-make-hashtb (info-alist hashtb)
897   "Setup folder info hashtable by INFO-ALIST on HASHTB."
898   (let* ((hashtb (or hashtb
899                      (elmo-make-hash (length info-alist)))))
900     (mapcar
901      (lambda (x)
902        (let ((info (cadr x)))
903          (and (intern-soft (car x) hashtb)
904               (elmo-set-hash-val (car x)
905                                  (list (nth 2 info)   ;; new
906                                        (nth 3 info)   ;; unread
907                                        (nth 1 info)   ;; length
908                                        (nth 0 info))  ;; max
909                                  hashtb))))
910      info-alist)
911     (setq elmo-folder-info-hashtb hashtb)))
912
913 (defsubst elmo-diff-new (diff)
914   (car diff))
915
916 (defsubst elmo-diff-unread (diff)
917   (when (consp (cdr diff))
918     (nth 1 diff)))
919
920 (defsubst elmo-diff-all (diff)
921   (if (consp (cdr diff))
922       (nth 2 diff)
923     (cdr diff)))
924
925 (defsubst elmo-strict-folder-diff (folder)
926   "Return folder diff information strictly from FOLDER."
927   (let* ((dir (elmo-folder-msgdb-path folder))
928          (nalist (elmo-msgdb-get-number-alist (elmo-folder-msgdb folder)))
929          (in-db (sort (mapcar 'car nalist) '<))
930          (in-folder  (elmo-folder-list-messages folder))
931          append-list delete-list diff)
932     (cons (if (equal in-folder in-db)
933               0
934             (setq diff (elmo-list-diff
935                         in-folder in-db
936                         nil
937                         ))
938             (setq append-list (car diff))
939             (setq delete-list (cadr diff))
940             (if append-list
941                 (length append-list)
942               (if delete-list
943                   (- 0 (length delete-list))
944                 0)))
945           (length in-folder))))
946
947 (luna-define-method elmo-folder-diff ((folder elmo-folder)
948                                       &optional numbers)
949   (elmo-generic-folder-diff folder numbers))
950
951 (defun elmo-generic-folder-diff (folder numbers)
952   (if (elmo-string-match-member (elmo-folder-name-internal folder)
953                                 elmo-strict-diff-folder-list)
954       (elmo-strict-folder-diff folder)
955     (let ((cached-in-db-max (elmo-folder-get-info-max folder))
956           (in-folder (elmo-folder-status folder))
957           (in-db t)
958           unsync messages
959           in-db-max)
960       (if numbers
961           (setq in-db-max (or (nth (max 0 (1- (length numbers))) numbers)
962                               0))
963         (if (not cached-in-db-max)
964             (let ((number-list (mapcar 'car
965                                        (elmo-msgdb-number-load
966                                         (elmo-folder-msgdb-path folder)))))
967               ;; No info-cache.
968               (setq in-db (sort number-list '<))
969               (setq in-db-max (or (nth (max 0 (1- (length in-db))) in-db)
970                                   0))
971               (elmo-folder-set-info-hashtb folder in-db-max nil))
972           (setq in-db-max cached-in-db-max)))
973       (setq unsync (if (and in-db (car in-folder))
974                        (- (car in-folder) in-db-max)
975                      (if (and in-folder (null in-db))
976                          (cdr in-folder)
977                        (car in-folder))))
978       (setq messages (cdr in-folder))
979       (if (and unsync messages (> unsync messages))
980           (setq unsync messages))
981       (cons (or unsync 0) (or messages 0)))))
982
983 (defvar elmo-folder-diff-async-callback nil)
984 (defvar elmo-folder-diff-async-callback-data nil)
985
986 (luna-define-method elmo-folder-diff-async ((folder elmo-folder))
987   (and elmo-folder-diff-async-callback
988        (funcall elmo-folder-diff-async-callback
989                 folder
990                 (elmo-folder-diff folder))))
991
992 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-folder))
993   (list folder))
994
995 (luna-define-method elmo-folder-contains-type ((folder elmo-folder) type)
996   (eq (elmo-folder-type-internal folder) type))
997
998 (luna-define-method elmo-folder-append-messages ((folder elmo-folder)
999                                                  src-folder
1000                                                  numbers
1001                                                  &optional
1002                                                  same-number)
1003   (elmo-generic-folder-append-messages folder src-folder numbers
1004                                        same-number))
1005
1006 (defun elmo-generic-folder-append-messages (folder src-folder numbers
1007                                                    same-number)
1008   (let (unseen table flag mark
1009                succeed-numbers failure cache)
1010     (setq table (elmo-flag-table-load (elmo-folder-msgdb-path folder)))
1011     (with-temp-buffer
1012       (set-buffer-multibyte nil)
1013       (while numbers
1014         (setq failure nil
1015               mark (elmo-message-mark src-folder (car numbers))
1016               flag (cond
1017                     ((null mark) nil)
1018                     ((member mark (elmo-msgdb-answered-marks))
1019                      'answered)
1020                     ;;
1021                     ((not (member mark (elmo-msgdb-unread-marks)))
1022                      'read)))
1023         (condition-case nil
1024             (setq cache (elmo-file-cache-get
1025                          (elmo-message-field src-folder
1026                                              (car numbers)
1027                                              'message-id))
1028                   failure
1029                   (not
1030                    (and
1031                     (elmo-message-fetch
1032                      src-folder (car numbers)
1033                      (if (elmo-folder-plugged-p src-folder)
1034                          (elmo-make-fetch-strategy
1035                           'entire 'maybe nil
1036                           (and cache (elmo-file-cache-path cache)))
1037                        (or (and elmo-enable-disconnected-operation
1038                                 cache
1039                                 (eq (elmo-file-cache-status cache) 'entire)
1040                                 (elmo-make-fetch-strategy
1041                                  'entire t nil
1042                                  (elmo-file-cache-path cache)))
1043                            (error "Unplugged")))
1044                      nil (current-buffer)
1045                      'unread)
1046                     (> (buffer-size) 0)
1047                     (elmo-folder-append-buffer
1048                      folder
1049                      flag
1050                      (if same-number (car numbers))))))
1051           (error (setq failure t)))
1052         ;; FETCH & APPEND finished
1053         (unless failure
1054           (when flag
1055             (elmo-flag-table-set table
1056                                  (elmo-message-field
1057                                   src-folder (car numbers)
1058                                   'message-id)
1059                                  flag))
1060           (setq succeed-numbers (cons (car numbers) succeed-numbers)))
1061         (elmo-progress-notify 'elmo-folder-move-messages)
1062         (setq numbers (cdr numbers)))
1063       (when (elmo-folder-persistent-p folder)
1064         (elmo-flag-table-save (elmo-folder-msgdb-path folder) table))
1065       succeed-numbers)))
1066
1067 ;; Arguments should be reduced.
1068 (defun elmo-folder-move-messages (src-folder msgs dst-folder
1069                                              &optional msgdb
1070                                              no-delete-info
1071                                              no-delete
1072                                              same-number
1073                                              save-unread)
1074   (save-excursion
1075     (let* ((messages msgs)
1076            (elmo-inhibit-display-retrieval-progress t)
1077            (len (length msgs))
1078            succeeds i result)
1079       (if (eq dst-folder 'null)
1080           (setq succeeds messages)
1081         (unless (elmo-folder-writable-p dst-folder)
1082           (error "move: %d is not writable"
1083                  (elmo-folder-name-internal dst-folder)))
1084         (when messages
1085           ;; src is already opened.
1086           (elmo-folder-open-internal dst-folder)
1087           (unless (setq succeeds (elmo-folder-append-messages dst-folder
1088                                                               src-folder
1089                                                               messages
1090                                                               same-number))
1091             (error "move: append message to %s failed"
1092                    (elmo-folder-name-internal dst-folder)))
1093           (elmo-folder-close dst-folder)))
1094       (if (and (not no-delete) succeeds)
1095           (progn
1096             (if (and (elmo-folder-delete-messages src-folder succeeds)
1097                      (elmo-folder-detach-messages src-folder succeeds))
1098                 (setq result t)
1099               (message "move: delete messages from %s failed."
1100                        (elmo-folder-name-internal src-folder))
1101               (setq result nil))
1102             result)
1103         (if no-delete
1104             (progn
1105               ;; (message "Copying messages...done")
1106               t)
1107           (if (eq len 0)
1108               (message "No message was moved.")
1109             (message "Moving messages failed.")
1110             nil ; failure
1111             ))))))
1112
1113 (defun elmo-folder-msgdb-path (folder)
1114   "Return the msgdb path for FOLDER."
1115   (or (elmo-folder-path-internal folder)
1116       (elmo-folder-set-path-internal
1117        folder
1118        (elmo-folder-expand-msgdb-path folder))))
1119
1120 (defun elmo-message-accessible-p (folder number)
1121   "Get accessibility of the message.
1122 Return non-nil when message is accessible."
1123   (or (elmo-folder-plugged-p folder)
1124       (elmo-folder-local-p folder)
1125       (elmo-msgdb-get-cached (elmo-folder-msgdb folder) number)))
1126
1127 (defun elmo-message-set-cached (folder number cached)
1128   "Set cache status of the message in the msgdb.
1129 FOLDER is the ELMO folder structure.
1130 NUMBER is a number of the message.
1131 If CACHED is t, message is set as cached."
1132   (when (elmo-msgdb-set-cached (elmo-folder-msgdb folder)
1133                                number
1134                                cached
1135                                (elmo-message-use-cache-p folder number))
1136     (elmo-folder-set-mark-modified-internal folder t)))
1137
1138 (defun elmo-message-copy-entity (entity)
1139   ;; 
1140   (elmo-msgdb-copy-overview-entity entity))
1141
1142 (defun elmo-message-entity-set-number (entity number)  
1143   (elmo-msgdb-overview-entity-set-number entity number))
1144
1145 (luna-define-generic elmo-message-entity (folder key)
1146   "Return the message-entity structure which matches to the KEY.
1147 KEY is a number or a string.
1148 A number is for message number in the FOLDER.
1149 A string is for message-d of the message.")
1150
1151 (luna-define-method elmo-message-entity ((folder elmo-folder) key)
1152   (elmo-msgdb-message-entity (elmo-folder-msgdb folder) key))
1153
1154 (luna-define-generic elmo-message-entity-parent (folder entity)
1155   "Return the parent message-entity structure in the FOLDER.
1156 ENTITY is the message-entity to get the parent.")
1157
1158 (luna-define-method elmo-message-entity-parent ((folder elmo-folder) entity)
1159   (elmo-msgdb-get-parent-entity entity (elmo-folder-msgdb folder)))
1160
1161 (put 'elmo-folder-do-each-message-entity 'lisp-indent-function '1)
1162 (def-edebug-spec elmo-folder-do-each-message-entity
1163   ((symbolp form &rest form) &rest form))
1164
1165 (defsubst elmo-folder-list-message-entities (folder)
1166   ;; List all message entities in the FOLDER.
1167   (mapcar
1168    (lambda (number) (elmo-message-entity folder number))
1169    (elmo-folder-list-messages folder t t)))
1170
1171 (defmacro elmo-folder-do-each-message-entity (spec &rest form)
1172   "Iterator for message entity in the folder.
1173 \(elmo-folder-do-each-message-entity \(entity folder\)
1174  ... do the process using entity...
1175 \)"
1176   `(dolist (,(car spec) (elmo-folder-list-message-entities ,(car (cdr spec))))
1177      ,@form))
1178
1179 (defmacro elmo-message-entity-number (entity)
1180   `(elmo-msgdb-overview-entity-get-number ,entity))
1181
1182 (defun elmo-message-entity-field (entity field &optional decode)
1183   "Get message entity field value.
1184 ENTITY is the message entity structure obtained by `elmo-message-entity'.
1185 FIELD is the symbol of the field name.
1186 if optional DECODE is non-nil, returned value is decoded."
1187   (elmo-msgdb-message-entity-field entity field decode))
1188
1189 (defun elmo-message-entity-set-field (entity field value)
1190   "Set message entity field value.
1191 ENTITY is the message entity structure.
1192 FIELD is the symbol of the field name.
1193 VALUE is the field value (raw)."
1194   (elmo-msgdb-message-entity-set-field entity field value))
1195
1196 (luna-define-generic elmo-folder-count-flags (folder)
1197   "Count flagged message number in the msgdb of the FOLDER.
1198 Return a list of numbers (`new' `unread' `answered')")
1199
1200 (luna-define-method elmo-folder-count-flags ((folder elmo-folder))
1201   (let ((new 0)
1202         (unreads 0)
1203         (answered 0))
1204     (dolist (elem (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))
1205       (cond
1206        ((string= (cadr elem) elmo-msgdb-new-mark)
1207         (incf new))
1208        ((member (cadr elem) (elmo-msgdb-unread-marks))
1209         (incf unreads))
1210        ((member (cadr elem) (elmo-msgdb-answered-marks))
1211         (incf answered))))
1212     (list new unreads answered)))
1213
1214 (defun elmo-message-set-flag (folder number flag)
1215   "Set message flag.
1216 FOLDER is a ELMO folder structure.
1217 NUMBER is a message number to set flag.
1218
1219 FLAG is a symbol which is one of the following:
1220   `unread'    (set the message as unread)
1221   `answered'  (set the message as answered)
1222   `important' (set the message as important)
1223 'sugar' flag:
1224   `read'      (remove new and unread flags)")
1225
1226 (defun elmo-message-unset-flag (folder number flag)
1227   "Unset message flag.
1228 FOLDER is a ELMO folder structure.
1229 NUMBER is a message number to set flag.
1230
1231 FLAG is a symbol which is one of the following:
1232   `unread'    (remove unread and new flag)
1233   `answered'  (remove answered flag)
1234   `important' (remove important flag)
1235 'sugar' flag:
1236   `read'      (set unread flag)")
1237
1238 (luna-define-generic elmo-message-mark (folder number)
1239   "Get mark of the message.
1240 FOLDER is the ELMO folder structure.
1241 NUMBER is a number of the message.")
1242
1243 (luna-define-method elmo-message-mark ((folder elmo-folder) number)
1244   (elmo-msgdb-get-mark (elmo-folder-msgdb folder) number))
1245
1246 (defun elmo-message-field (folder number field)
1247   "Get message field value in the msgdb.
1248 FOLDER is the ELMO folder structure.
1249 NUMBER is a number of the message.
1250 FIELD is a symbol of the field."
1251   (elmo-msgdb-get-field (elmo-folder-msgdb folder) number field))
1252
1253 (luna-define-method elmo-message-use-cache-p ((folder elmo-folder) number)
1254   nil) ; default is not use cache.
1255
1256 (luna-define-method elmo-message-folder ((folder elmo-folder) number)
1257   folder) ; default is folder
1258
1259 (luna-define-method elmo-folder-unmark-important ((folder elmo-folder)
1260                                                   numbers
1261                                                   &optional ignore-flags)
1262   (when (elmo-folder-msgdb-internal folder)
1263     (dolist (number numbers)
1264       (elmo-msgdb-unset-flag (elmo-folder-msgdb folder)
1265                              folder
1266                              number
1267                              'important))))
1268
1269 (luna-define-method elmo-folder-mark-as-important ((folder elmo-folder)
1270                                                    numbers
1271                                                    &optional ignore-flags)
1272   (when (elmo-folder-msgdb-internal folder)
1273     (dolist (number numbers)
1274       (elmo-msgdb-set-flag (elmo-folder-msgdb folder)
1275                            folder
1276                            number
1277                            'important))))
1278
1279 (luna-define-method elmo-folder-unmark-read ((folder elmo-folder)
1280                                              numbers
1281                                              &optional ignore-flags)
1282   (when (elmo-folder-msgdb-internal folder)
1283     (dolist (number numbers)
1284       (elmo-msgdb-unset-flag (elmo-folder-msgdb folder)
1285                              folder
1286                              number
1287                              'read))))
1288
1289 (luna-define-method elmo-folder-mark-as-read ((folder elmo-folder)
1290                                               numbers
1291                                               &optional ignore-flag)
1292   (when (elmo-folder-msgdb-internal folder)
1293     (dolist (number numbers)
1294       (elmo-msgdb-set-flag (elmo-folder-msgdb folder)
1295                            folder
1296                            number
1297                            'read))))
1298
1299 (luna-define-method elmo-folder-unmark-answered ((folder elmo-folder) numbers)
1300   (when (elmo-folder-msgdb-internal folder)
1301     (dolist (number numbers)
1302       (elmo-msgdb-unset-flag (elmo-folder-msgdb folder)
1303                              folder
1304                              number
1305                              'answered))))
1306
1307 (luna-define-method elmo-folder-mark-as-answered ((folder elmo-folder) numbers)
1308   (when (elmo-folder-msgdb-internal folder)
1309     (dolist (number numbers)
1310       (elmo-msgdb-set-flag (elmo-folder-msgdb folder)
1311                            folder
1312                            number
1313                            'answered))))
1314
1315 (luna-define-method elmo-folder-process-crosspost ((folder elmo-folder))
1316   ;; Do nothing.
1317   )
1318
1319 ;;(luna-define-generic elmo-folder-append-message-entity (folder entity
1320 ;;                                                             &optional
1321 ;;                                                             flag-table)
1322 ;;  "Append ENTITY to the folder.")
1323
1324 (defun elmo-generic-folder-append-msgdb (folder append-msgdb)
1325   (if append-msgdb
1326       (let* ((number-alist (elmo-msgdb-get-number-alist append-msgdb))
1327              (all-alist (copy-sequence (append
1328                                         (elmo-msgdb-get-number-alist
1329                                          (elmo-folder-msgdb folder))
1330                                         number-alist)))
1331              (cur number-alist)
1332              pair overview
1333              to-be-deleted
1334              mark-alist)
1335         (elmo-folder-set-msgdb-internal folder
1336                                         (elmo-msgdb-append
1337                                          (elmo-folder-msgdb folder)
1338                                          append-msgdb))
1339         (while cur
1340           (setq all-alist (delq (car cur) all-alist))
1341           ;; same message id exists.
1342           (if (setq pair (rassoc (cdr (car cur)) all-alist))
1343               (setq to-be-deleted (nconc to-be-deleted (list (car pair)))))
1344           (setq cur (cdr cur)))
1345         (cond ((eq (elmo-folder-process-duplicates-internal folder)
1346                    'hide)
1347                ;; Hide duplicates.
1348                (setq overview (elmo-delete-if
1349                                (lambda (x)
1350                                  (memq (elmo-msgdb-overview-entity-get-number
1351                                         x)
1352                                        to-be-deleted))
1353                                (elmo-msgdb-get-overview append-msgdb)))
1354                ;; Should be mark as read.
1355                (elmo-folder-mark-as-read folder to-be-deleted)
1356                (elmo-msgdb-set-overview append-msgdb overview))
1357               ((eq (elmo-folder-process-duplicates-internal folder)
1358                    'read)
1359                ;; Mark as read duplicates.
1360                (elmo-folder-mark-as-read folder to-be-deleted))
1361               (t
1362                ;; Do nothing.
1363                (setq to-be-deleted nil)))
1364         (length to-be-deleted))
1365     0))
1366
1367 (luna-define-method elmo-folder-append-msgdb ((folder elmo-folder)
1368                                               append-msgdb)
1369   (elmo-generic-folder-append-msgdb folder append-msgdb))
1370
1371 (defun elmo-folder-confirm-appends (appends)
1372   (let ((len (length appends))
1373         in)
1374     (if (and elmo-folder-update-threshold
1375              (> len elmo-folder-update-threshold)
1376              elmo-folder-update-confirm)
1377         (if (y-or-n-p (format "Too many messages(%d).  Update all? " len))
1378             appends
1379           (setq in elmo-folder-update-threshold)
1380           (catch 'end
1381             (while t
1382               (setq in (read-from-minibuffer "Update number: "
1383                                              (int-to-string in))
1384                     in (string-to-int in))
1385               (if (< len in)
1386                   (throw 'end len))
1387               (if (y-or-n-p (format "%d messages are not appeared.  OK? "
1388                                     (max (- len in) 0)))
1389                   (throw 'end in))))
1390           (nthcdr (max (- len in) 0) appends))
1391       (if (and elmo-folder-update-threshold
1392                (> len elmo-folder-update-threshold)
1393                (not elmo-folder-update-confirm))
1394           (nthcdr (max (- len elmo-folder-update-threshold) 0) appends)
1395         appends))))
1396
1397 (luna-define-method elmo-message-fetch ((folder elmo-folder)
1398                                         number strategy
1399                                         &optional
1400                                         section
1401                                         outbuf
1402                                         unread)
1403   (if outbuf
1404       (with-current-buffer outbuf
1405         (erase-buffer)
1406         (elmo-message-fetch-with-cache-process folder number
1407                                                strategy section unread))
1408     (with-temp-buffer
1409       (elmo-message-fetch-with-cache-process folder number
1410                                              strategy section unread)
1411       (buffer-string))))
1412
1413 (luna-define-method elmo-message-fetch-with-cache-process ((folder elmo-folder)
1414                                                            number strategy
1415                                                            &optional
1416                                                            section unread)
1417   (let ((cache-path (elmo-fetch-strategy-cache-path strategy))
1418         (method-priorities
1419          (cond ((eq (elmo-fetch-strategy-use-cache strategy) 'maybe)
1420                 '(entity cache))
1421                ((elmo-fetch-strategy-use-cache strategy)
1422                 '(cache entity))
1423                (t
1424                 '(entity))))
1425         result err)
1426     (while (and method-priorities
1427                 (null result))
1428       (setq result
1429             (case (car method-priorities)
1430               (cache
1431                (elmo-file-cache-load cache-path section))
1432               (entity
1433                (when (and (condition-case error
1434                               (elmo-message-fetch-internal folder number
1435                                                            strategy
1436                                                            section
1437                                                            unread)
1438                             (error (setq err error) nil))
1439                           (> (buffer-size) 0))
1440                  (elmo-delete-cr-buffer)
1441                  (when (and (elmo-fetch-strategy-save-cache strategy)
1442                             cache-path)
1443                    (elmo-file-cache-save cache-path section))
1444                  t)))
1445             method-priorities (cdr method-priorities)))
1446     (or result
1447         (and err (signal (car err) (cdr err))))))
1448
1449 (luna-define-method elmo-folder-clear ((folder elmo-folder)
1450                                        &optional keep-killed)
1451   (unless keep-killed
1452     (elmo-folder-set-killed-list-internal folder nil))
1453   (elmo-folder-set-msgdb-internal folder (elmo-msgdb-clear)))
1454
1455 (luna-define-generic elmo-folder-synchronize (folder
1456                                               &optional ignore-msgdb
1457                                               no-check)
1458   "Synchronize the folder data to the newest status.
1459 FOLDER is the ELMO folder structure.
1460
1461 If optional IGNORE-MSGDB is non-nil, current msgdb is thrown away except
1462 flag status. If IGNORE-MSGDB is 'visible-only, only visible messages
1463 \(the messages which are not in the killed-list\) are thrown away and
1464 synchronized.
1465 If NO-CHECK is non-nil, rechecking folder is skipped.
1466 Return a list of a cross-posted message number.
1467 If update process is interrupted, return nil.")
1468                                               
1469 (luna-define-method elmo-folder-synchronize ((folder elmo-folder)
1470                                              &optional ignore-msgdb no-check)
1471   (let ((killed-list (elmo-folder-killed-list-internal folder))
1472         (before-append t)
1473         number-alist
1474         old-msgdb diff diff-2 delete-list new-list new-msgdb mark
1475         flag-table crossed after-append numbers)
1476     (setq old-msgdb (elmo-folder-msgdb folder))
1477     (setq flag-table (elmo-flag-table-load (elmo-folder-msgdb-path folder)))
1478     (when ignore-msgdb
1479       (elmo-msgdb-flag-table (elmo-folder-msgdb folder) flag-table)
1480       (elmo-folder-clear folder (eq ignore-msgdb 'visible-only)))
1481     (setq numbers (sort (elmo-folder-list-messages folder nil t) '<))
1482     (unless no-check (elmo-folder-check folder))
1483     (condition-case nil
1484         (progn
1485           (message "Checking folder diff...")
1486           ;; TODO: killed list is loaded in elmo-folder-open and
1487           ;; list-messages use internal killed-list-folder.
1488           (setq diff (elmo-list-diff (elmo-folder-list-messages
1489                                       folder
1490                                       (eq 'visible-only ignore-msgdb))
1491                                      numbers))
1492           (message "Checking folder diff...done")
1493           (setq new-list (elmo-folder-confirm-appends (car diff)))
1494           ;; Set killed list.
1495           (when (and (not (eq (length (car diff))
1496                               (length new-list)))
1497                      (setq diff-2 (elmo-list-diff (car diff) new-list)))
1498             (elmo-msgdb-append-to-killed-list folder (car diff-2)))
1499           (setq delete-list (cadr diff))
1500           (if (or (equal diff '(nil nil))
1501                   (equal diff '(nil))
1502                   (and (eq (length (car diff)) 0)
1503                        (eq (length (cadr diff)) 0)))
1504               (progn
1505                 (elmo-folder-update-number folder)
1506                 (elmo-folder-process-crosspost folder)
1507                 0 ; no updates.
1508                 )
1509             (when delete-list
1510               (elmo-folder-detach-messages folder delete-list))
1511             (when new-list
1512               (elmo-msgdb-change-mark (elmo-folder-msgdb folder)
1513                                       elmo-msgdb-new-mark
1514                                       elmo-msgdb-unread-uncached-mark)
1515               (setq new-msgdb (elmo-folder-msgdb-create
1516                                folder new-list flag-table))
1517               ;; Clear flag-table
1518               (if (elmo-folder-persistent-p folder)
1519                   (elmo-flag-table-save (elmo-folder-msgdb-path folder)
1520                                         nil))
1521               (setq before-append nil)
1522               (setq crossed (elmo-folder-append-msgdb folder new-msgdb))
1523               ;; process crosspost.
1524               ;; Return a cons cell of (NUMBER-CROSSPOSTS . NEW-MARK-ALIST).
1525               (elmo-folder-process-crosspost folder)
1526               (elmo-folder-set-message-modified-internal folder t)
1527               (elmo-folder-set-mark-modified-internal folder t))
1528             ;; return value.
1529             (or crossed 0)))
1530       (quit
1531        ;; Resume to the original status.
1532        (if before-append (elmo-folder-set-msgdb-internal folder old-msgdb))
1533        (elmo-folder-set-killed-list-internal folder killed-list)
1534        nil))))
1535
1536 (luna-define-generic elmo-folder-detach-messages (folder numbers)
1537   "Remove messages with NUMBERS from MSGDB.")
1538
1539 (luna-define-method elmo-folder-detach-messages ((folder elmo-folder)
1540                                                  numbers)
1541   (elmo-msgdb-delete-msgs (elmo-folder-msgdb folder) numbers))
1542
1543 (luna-define-generic elmo-folder-length (folder)
1544   "Return number of messages in the FOLDER.")
1545
1546 (luna-define-method elmo-folder-length ((folder elmo-folder))
1547   (elmo-msgdb-length (elmo-folder-msgdb folder)))
1548
1549 (defun elmo-msgdb-load (folder &optional silent)
1550   (unless silent
1551     (message "Loading msgdb for %s..." (elmo-folder-name-internal folder)))
1552   (let ((msgdb (elmo-load-msgdb (elmo-folder-msgdb-path folder))))
1553     (elmo-folder-set-info-max-by-numdb folder
1554                                        (elmo-msgdb-get-number-alist msgdb))
1555     
1556     (unless silent
1557       (message "Loading msgdb for %s...done"
1558                (elmo-folder-name-internal folder)))
1559     msgdb))
1560   
1561 (defun elmo-msgdb-delete-path (folder)
1562   (let ((path (elmo-folder-msgdb-path folder)))
1563     (if (file-directory-p path)
1564         (elmo-delete-directory path t))))
1565
1566 (defun elmo-msgdb-rename-path (old-folder new-folder)
1567   (let* ((old (directory-file-name (elmo-folder-msgdb-path old-folder)))
1568          (new (directory-file-name (elmo-folder-msgdb-path new-folder)))
1569          (new-dir (directory-file-name (file-name-directory new))))
1570     (if (not (file-directory-p old))
1571         ()
1572       (if (file-exists-p new)
1573           (error "Already exists directory: %s" new)
1574         (if (not (file-exists-p new-dir))
1575             (elmo-make-directory new-dir))
1576         (rename-file old new)))))
1577
1578 (defun elmo-setup-subscribed-newsgroups (groups)
1579   "Setup subscribed newsgroups.
1580 GROUPS is a list of newsgroup name string.
1581 Return a hashtable for newsgroups."
1582   (let ((hashtb (or elmo-newsgroups-hashtb
1583                     (setq elmo-newsgroups-hashtb
1584                           (elmo-make-hash (length groups))))))
1585     (dolist (group groups)
1586       (or (elmo-get-hash-val group hashtb)
1587           (elmo-set-hash-val group nil hashtb)))
1588     (setq elmo-newsgroups-hashtb hashtb)))
1589
1590 (defvar elmo-crosspost-message-alist-modified nil)
1591 (defun elmo-crosspost-message-alist-load ()
1592   "Load crosspost message alist."
1593   (setq elmo-crosspost-message-alist (elmo-crosspost-alist-load))
1594   (setq elmo-crosspost-message-alist-modified nil))
1595
1596 (defun elmo-crosspost-message-alist-save ()
1597   "Save crosspost message alist."
1598   (when elmo-crosspost-message-alist-modified
1599     (let ((alist elmo-crosspost-message-alist)
1600           newsgroups)
1601       (while alist
1602         (setq newsgroups
1603               (elmo-delete-if
1604                '(lambda (x)
1605                   (not (intern-soft x elmo-newsgroups-hashtb)))
1606                (nth 1 (car alist))))
1607         (if newsgroups
1608             (setcar (cdar alist) newsgroups)
1609           (setq elmo-crosspost-message-alist
1610                 (delete (car alist) elmo-crosspost-message-alist)))
1611         (setq alist (cdr alist)))
1612       (elmo-crosspost-alist-save elmo-crosspost-message-alist)
1613       (setq elmo-crosspost-message-alist-modified nil))))
1614
1615 (defun elmo-folder-make-temporary-directory (folder)
1616   ;; Make a temporary directory for FOLDER.
1617   (let ((temp-dir (make-temp-name
1618                    (concat
1619                     (file-name-as-directory (elmo-folder-msgdb-path folder))
1620                     "elmo"))))
1621     (elmo-make-directory temp-dir)
1622     temp-dir))
1623
1624 (defun elmo-init ()
1625   "Initialize ELMO module."
1626   (elmo-crosspost-message-alist-load)
1627   (elmo-resque-obsolete-variables)
1628   (elmo-dop-queue-load))
1629
1630 (defun elmo-quit ()
1631   "Quit and cleanup ELMO."
1632   (elmo-crosspost-message-alist-save)
1633   (elmo-dop-queue-save)
1634   ;; Not implemented yet.
1635   (let ((types elmo-folder-type-alist)
1636         class)
1637     (while types
1638       (setq class
1639             (luna-find-class
1640              (intern (format "elmo-%s-folder" (symbol-name (cdr (car types)))))))
1641       ;; Call all folder's `elmo-quit' method.
1642       (if class
1643           (dolist (func (luna-class-find-functions class 'elmo-quit))
1644             (funcall func nil)))
1645       (setq types (cdr types)))))
1646
1647 (luna-define-method elmo-folder-rename-internal ((folder elmo-folder)
1648                                                  new-folder)
1649   (error "Cannot rename %s folder"
1650          (symbol-name (elmo-folder-type-internal folder))))
1651
1652
1653 ;;; Define folders.
1654 (elmo-define-folder ?% 'imap4)
1655 (elmo-define-folder ?-  'nntp)
1656 (elmo-define-folder ?\+ 'localdir)
1657 (elmo-define-folder ?\* 'multi)
1658 (elmo-define-folder ?\/ 'filter)
1659 (elmo-define-folder ?\$ 'archive)
1660 (elmo-define-folder ?&  'pop3)
1661 (elmo-define-folder ?=  'localnews)
1662 (elmo-define-folder ?|  'pipe)
1663 (elmo-define-folder ?.  'maildir)
1664 (elmo-define-folder ?'  'internal)
1665 (elmo-define-folder ?\[  'nmz)
1666 (elmo-define-folder ?@  'shimbun)
1667
1668 ;;; Obsolete variables.
1669 (elmo-define-obsolete-variable 'elmo-default-imap4-mailbox
1670                                'elmo-imap4-default-mailbox)
1671 (elmo-define-obsolete-variable 'elmo-default-imap4-server
1672                                'elmo-imap4-default-server)
1673 (elmo-define-obsolete-variable 'elmo-default-imap4-authenticate-type
1674                                'elmo-imap4-default-authenticate-type)
1675 (elmo-define-obsolete-variable 'elmo-default-imap4-user
1676                                'elmo-imap4-default-user)
1677 (elmo-define-obsolete-variable 'elmo-default-imap4-port
1678                                'elmo-imap4-default-port)
1679 (elmo-define-obsolete-variable 'elmo-default-imap4-stream-type
1680                                'elmo-imap4-default-stream-type)
1681 (elmo-define-obsolete-variable 'elmo-default-nntp-server
1682                                'elmo-nntp-default-server)
1683 (elmo-define-obsolete-variable 'elmo-default-nntp-user
1684                                'elmo-nntp-default-user)
1685 (elmo-define-obsolete-variable 'elmo-default-nntp-port
1686                                'elmo-nntp-default-port)
1687 (elmo-define-obsolete-variable 'elmo-default-nntp-stream-type
1688                                'elmo-nntp-default-stream-type)
1689 (elmo-define-obsolete-variable 'elmo-default-pop3-server
1690                                'elmo-pop3-default-server)
1691 (elmo-define-obsolete-variable 'elmo-default-pop3-user
1692                                'elmo-pop3-default-user)
1693 (elmo-define-obsolete-variable 'elmo-default-pop3-authenticate-type
1694                                'elmo-pop3-default-authenticate-type)
1695 (elmo-define-obsolete-variable 'elmo-default-pop3-port
1696                                'elmo-pop3-default-port)
1697 (elmo-define-obsolete-variable 'elmo-default-pop3-stream-type
1698                                'elmo-pop3-default-stream-type)
1699 (elmo-define-obsolete-variable 'elmo-cache-dirname
1700                                'elmo-cache-directory)
1701 (elmo-define-obsolete-variable 'elmo-msgdb-dir
1702                                'elmo-msgdb-directory)
1703
1704 ;; Obsolete functions.
1705 ;; 2001-12-11: *-dir -> *-directory
1706 (defalias 'elmo-folder-make-temp-dir 'elmo-folder-make-temporary-directory)
1707 (make-obsolete 'elmo-folder-make-temp-dir
1708                'elmo-folder-make-temporary-directory)
1709
1710
1711 ;; autoloads
1712 (autoload 'elmo-dop-queue-flush "elmo-dop")
1713 (autoload 'elmo-nntp-post "elmo-nntp")
1714
1715 (require 'product)
1716 (product-provide (provide 'elmo) (require 'elmo-version))
1717
1718 ;;; elmo.el ends here