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