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