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