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