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