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