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