1 ;;; elmo.el --- Elisp Library for Message Orchestration.
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
6 ;; Keywords: mail, net news
8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
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)
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.
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.
34 (require 'elmo-version) ; reduce recursive-load-depth
39 (eval-when-compile (require 'cl))
41 (if (or (featurep 'dbm)
44 (featurep 'berkeley-db))
45 (require 'elmo-database))
47 (defcustom elmo-message-fetch-threshold 30000
49 :type '(choice (integer :tag "Threshold (bytes)")
50 (const :tag "No limitation" nil))
53 (defcustom elmo-message-fetch-confirm t
54 "If non-nil, confirm fetching if message size is larger than
55 `elmo-message-fetch-threshold'.
56 Otherwise, entire fetching of the message is aborted without confirmation."
60 (defcustom elmo-folder-update-threshold 500
65 (defcustom elmo-folder-update-confirm t
66 "Confirm if update number exceeds `elmo-folder-update-threshold'."
70 (defvar elmo-message-displaying nil
71 "A global switch to indicate message is displaying or not.")
74 (defvar elmo-folder-type-alist nil)
76 (defvar elmo-newsgroups-hashtb nil)
78 (elmo-define-error 'elmo-error "Error" 'error)
79 (elmo-define-error 'elmo-open-error "Cannot open" 'elmo-error)
80 (elmo-define-error 'elmo-authenticate-error "Login failed" 'elmo-open-error)
81 (elmo-define-error 'elmo-imap4-bye-error "IMAP4 session was terminated" 'elmo-open-error)
85 (autoload 'elmo-dop-queue-flush "elmo-dop")
86 (autoload 'elmo-nntp-post "elmo-nntp")
87 (autoload 'elmo-global-flag-p "elmo-flag")
88 (autoload 'elmo-global-flag-detach "elmo-flag")
89 (autoload 'elmo-global-flag-detach-messages "elmo-flag")
90 (autoload 'elmo-global-flag-set "elmo-flag")
91 (autoload 'elmo-get-global-flags "elmo-flag")
92 (autoload 'elmo-global-mark-migrate "elmo-flag")
93 (autoload 'elmo-folder-list-global-flag-messages "elmo-flag"))
95 (defun elmo-define-folder (prefix backend)
97 If a folder name begins with PREFIX, use BACKEND."
98 (let ((pair (assq prefix elmo-folder-type-alist)))
102 (setcdr pair backend))
103 (setq elmo-folder-type-alist (cons (cons prefix backend)
104 elmo-folder-type-alist)))))
106 (defmacro elmo-folder-type (name)
107 "Get folder type from NAME string."
108 `(and (stringp ,name)
109 (cdr (assoc (string-to-char ,name) elmo-folder-type-alist))))
112 ;; A elmo folder provides uniformed (orchestrated) access
113 ;; to the internet messages.
115 (luna-define-class elmo-folder () (type ; folder type symbol.
116 name ; orignal folder name string.
117 prefix ; prefix for folder name
118 path ; directory path for msgdb.
119 msgdb ; msgdb (may be nil).
120 killed-list ; killed list.
121 flag-table ; flag table.
122 persistent ; non-nil if persistent.
123 process-duplicates ; read or hide
124 biff ; folder for biff
126 (luna-define-internal-accessors 'elmo-folder))
128 (luna-define-generic elmo-folder-initialize (folder name)
129 ;; Initialize a FOLDER structure with NAME."
132 (defmacro elmo-folder-send (folder message &rest args)
133 "Let FOLDER receive the MESSAGE with ARGS."
134 (` (luna-send (, folder) (, message) (, folder) (,@ args))))
137 (defun elmo-make-folder (name &optional non-persistent)
138 "Make an ELMO folder structure specified by NAME.
139 If optional argument NON-PERSISTENT is non-nil, the folder msgdb is not saved."
140 (let ((type (elmo-folder-type name))
141 prefix split class folder original)
142 (setq original (elmo-string name))
145 (setq prefix (elmo-string (substring name 0 1)))
146 (setq name (elmo-string (substring name 1))))
147 (setq type (intern (car (setq split (split-string name ":")))))
148 (if (>= (length split) 2)
149 (setq name (substring name (+ 1 (length (car split)))))
150 (error "Error in folder name `%s'" original))
151 (setq prefix (concat (car split) ":")))
152 (setq class (format "elmo-%s" (symbol-name type)))
153 (require (intern class))
154 (setq folder (luna-make-entity (intern (concat class "-folder"))
158 :persistent (not non-persistent)))
160 (elmo-folder-send folder 'elmo-folder-initialize name))))
162 ;; Note that this function is for internal use only.
163 (luna-define-generic elmo-folder-msgdb (folder)
164 "Return the msgdb of FOLDER (on-demand loading).
165 \(For internal use only.\)")
167 (luna-define-method elmo-folder-msgdb ((folder elmo-folder))
168 (or (elmo-folder-msgdb-internal folder)
169 (elmo-folder-set-msgdb-internal folder
170 (elmo-folder-msgdb-load folder))))
172 (luna-define-generic elmo-folder-open (folder &optional load-msgdb)
173 "Open and setup (load saved status) FOLDER.
174 If optional LOAD-MSGDB is non-nil, msgdb is loaded.
175 \(otherwise, msgdb is loaded on-demand)")
177 (luna-define-generic elmo-folder-open-internal (folder)
178 "Open FOLDER (without loading saved folder status).")
180 (luna-define-generic elmo-folder-check (folder)
181 "Check the FOLDER to obtain newest information at the next list operation.")
183 (luna-define-generic elmo-folder-clear (folder &optional keep-killed)
184 "Clear FOLDER to the initial state.
185 If optional KEEP-KILLED is non-nil, killed-list is not cleared.")
187 (luna-define-generic elmo-folder-commit (folder)
188 "Save current status of FOLDER.")
190 (luna-define-generic elmo-folder-close (folder)
191 "Close, save and clearnup FOLDER.")
193 (luna-define-generic elmo-folder-close-internal (folder)
194 "Close FOLDER (without saving folder status).")
196 (luna-define-generic elmo-folder-plugged-p (folder)
197 "Returns t if FOLDER is plugged.")
199 (luna-define-generic elmo-folder-set-plugged (folder plugged &optional add)
200 "Set FOLDER as plugged.")
202 (luna-define-generic elmo-net-port-info (folder)
203 "Get port information of FOLDER.")
205 (luna-define-generic elmo-folder-use-flag-p (folder)
206 "Returns t if FOLDER treats unread/important flag itself.")
208 (luna-define-generic elmo-folder-diff (folder)
210 Return value is cons cell or list:
211 - a cons cell (new . all)
212 - a list (new unread all)")
214 (luna-define-generic elmo-folder-status (folder)
215 "Returns a cons cell of (MAX-NUMBER . MESSAGES) in the FOLDER.")
217 (luna-define-generic elmo-folder-reserve-status-p (folder)
218 "If non-nil, the folder should not close folder after `elmo-folder-status'.")
220 (luna-define-generic elmo-folder-list-messages (folder &optional visible-only
222 "Return a list of message numbers contained in FOLDER.
223 If optional VISIBLE-ONLY is non-nil, killed messages are not listed.
224 If second optional IN-MSGDB is non-nil, only messages in the msgdb are listed.")
226 (luna-define-method elmo-folder-list-messages ((folder elmo-folder)
227 &optional visible-only in-msgdb)
228 (let ((list (if in-msgdb
230 (elmo-folder-list-messages-internal folder visible-only)))
231 (killed-list (elmo-folder-killed-list-internal folder)))
234 (setq list (elmo-msgdb-list-messages (elmo-folder-msgdb folder))))
236 (elmo-living-messages list killed-list)
237 (if (and in-msgdb killed-list)
238 (elmo-uniq-sorted-list
239 (sort (nconc (elmo-number-set-to-number-list killed-list) list) #'<)
243 (luna-define-generic elmo-folder-list-messages-internal (folder &optional
245 ;; Return a list of message numbers contained in FOLDER.
246 ;; Return t if the message list is not available.
249 (luna-define-generic elmo-folder-list-flagged (folder flag &optional in-msgdb)
250 "List messages in the FOLDER with FLAG.
251 FLAG is a symbol which is one of the following:
253 `unread' (unread messages (new messages are included))
254 `answered' (answered or forwarded)
255 `important' (marked as important)
258 `digest' (unread + important + other flags)
259 `any' (digest + answered + other flags)
260 If optional IN-MSGDB is non-nil, retrieve flag information from msgdb.")
262 (luna-define-method elmo-folder-list-flagged ((folder elmo-folder) flag
264 (let ((msgs (if in-msgdb
266 (elmo-folder-list-flagged-internal folder flag))))
268 (setq msgs (elmo-msgdb-list-flagged (elmo-folder-msgdb folder) flag)))
272 (nconc (elmo-folder-list-global-flag-messages folder flag) msgs)
275 (luna-define-generic elmo-folder-list-flagged-internal (folder flag)
276 "Return a list of message in the FOLDER with FLAG.
277 Return t if the message list is not available.")
279 (luna-define-method elmo-folder-list-flagged-internal ((folder elmo-folder)
283 (luna-define-generic elmo-folder-list-subfolders (folder &optional one-level)
284 "Returns a list of subfolders contained in FOLDER.
285 If optional argument ONE-LEVEL is non-nil, only children of FOLDER is returned.
286 \(a folder which have children is returned as a list\)
287 Otherwise, all descendent folders are returned.")
289 (luna-define-generic elmo-folder-have-subfolder-p (folder)
290 "Return non-nil when FOLDER has subfolders.")
292 (luna-define-generic elmo-folder-exists-p (folder)
293 "Returns non-nil when FOLDER exists.")
295 (luna-define-generic elmo-folder-creatable-p (folder)
296 "Returns non-nil when FOLDER is creatable.")
298 (luna-define-generic elmo-folder-writable-p (folder)
299 "Returns non-nil when FOLDER is writable.")
301 (luna-define-generic elmo-folder-persistent-p (folder)
302 "Return non-nil when FOLDER is persistent.")
304 (luna-define-generic elmo-folder-create (folder)
307 (luna-define-generic elmo-message-deletable-p (folder number)
308 "Returns non-nil when the message in the FOLDER with NUMBER is deletable.")
310 (luna-define-generic elmo-folder-delete (folder)
311 "Delete FOLDER completely.")
313 (luna-define-generic elmo-folder-rename (folder new-name)
314 "Rename FOLDER to NEW-NAME (string).")
316 (luna-define-generic elmo-folder-delete-messages (folder numbers)
318 FOLDER is the ELMO folder structure.
319 NUMBERS is a list of message numbers to be deleted.
320 It is not recommended to use this function other than internal use.
321 Use `elmo-folder-move-messages' with dst-folder 'null instead.")
323 (luna-define-generic elmo-folder-search (folder condition &optional numbers)
324 "Search and return list of message numbers.
325 FOLDER is the ELMO folder structure.
326 CONDITION is a condition structure for searching.
327 If optional argument NUMBERS is specified and is a list of message numbers,
328 messages are searched from the list.")
330 (luna-define-generic elmo-message-match-condition (folder number
333 "Return non-nil when the message in the FOLDER with NUMBER is matched.
334 CONDITION is a condition structure for testing.
335 NUMBERS is a list of message numbers,
336 use to be test for \"last\" and \"first\" predicates.")
338 (luna-define-generic elmo-folder-msgdb-create (folder numbers flag-table)
339 "Create a message database (implemented in each backends).
340 FOLDER is the ELMO folder structure.
341 NUMBERS is a list of message numbers to create msgdb.
342 FLAG-TABLE is a hashtable of message-id and flag.")
344 (luna-define-generic elmo-folder-set-flag (folder numbers flag
347 FOLDER is a ELMO folder structure.
348 NUMBERS is a list of message number to set flag.
350 FLAG is a symbol which is one of the following:
351 `unread' (set the message as unread)
352 `answered' (set the message as answered)
353 `important' (set the message as important)
355 `read' (remove new and unread flags)
356 If optional IS-LOCAL is non-nil, update only local (not server) status.")
358 (luna-define-generic elmo-folder-unset-flag (folder numbers flag
360 "Unset messages flag.
361 FOLDER is a ELMO folder structure.
362 NUMBERS is a list of message number to unset flag.
364 FLAG is a symbol which is one of the following:
365 `unread' (remove unread and new flag)
366 `answered' (remove answered flag)
367 `important' (remove important flag)
369 `read' (set unread flag)
370 `all' (remove all flags)
371 If optional IS-LOCAL is non-nil, update only local (not server) status.")
373 (luna-define-generic elmo-message-flag-available-p (folder number flag)
374 "Return non-nil when a message in the FOLDER with NUMBER treats FLAG.")
376 (luna-define-generic elmo-folder-next-message-number (folder)
377 "The next message number that will be assigned to a new message.
378 FOLDER is the ELMO folder structure.")
380 (luna-define-generic elmo-folder-append-buffer (folder &optional flags
382 "Append current buffer as a new message.
383 FOLDER is the destination folder (ELMO folder structure).
384 FLAGS is the flag list for the appended message (list of symbols).
385 If FLAGS contain `read', the message is appended as `not-unread'.
386 If it is nil, the appended message will be treated as `new'.
387 If optional argument NUMBER is specified, the new message number is set
389 Return nil on failure.")
391 (luna-define-generic elmo-folder-append-messages (folder
396 "Append messages from folder.
397 FOLDER is the ELMO folder structure.
398 Caller should make sure FOLDER is `writable'.
399 \(Can be checked with `elmo-folder-writable-p'\).
400 SRC-FOLDER is the source ELMO folder structure.
401 NUMBERS is the message numbers to be appended in the SRC-FOLDER.
402 If second optional argument SAME-NUMBER is specified,
403 message number is preserved \(if possible\).
404 Returns a list of message numbers successfully appended.")
406 (luna-define-generic elmo-folder-pack-numbers (folder)
407 "Pack message numbers of FOLDER.")
409 (luna-define-generic elmo-folder-update-number (folder)
410 "Update number of FOLDER.")
412 (luna-define-generic elmo-folder-diff-async (folder)
413 "Get diff of FOLDER asynchronously.")
415 (luna-define-generic elmo-folder-expand-msgdb-path (folder)
416 "Expand path for FOLDER.")
418 (luna-define-generic elmo-folder-get-primitive-list (folder)
419 "Get primitive folder structure list contained in FOLDER.")
421 (luna-define-generic elmo-folder-contains-type (folder type)
422 "Returns t if FOLDER contains TYPE.")
424 (luna-define-generic elmo-folder-local-p (folder)
425 "Returns t if FOLDER is local.")
427 (luna-define-generic elmo-folder-message-file-p (folder)
428 "Returns t if all messages in the FOLDER are files.")
431 (luna-define-generic elmo-message-use-cache-p (folder number)
432 "Returns t if the message in the FOLDER with NUMBER uses cache.")
434 (luna-define-generic elmo-message-file-name (folder number)
435 "Return the file name of a message specified by FOLDER and NUMBER.")
439 ;;; Use original file
440 (luna-define-generic elmo-folder-message-file-number-p (folder)
441 "Return t if the file name in the FOLDER is the message number.")
443 (luna-define-generic elmo-folder-message-file-directory (folder)
444 "Return the directory of the message files of FOLDER.")
446 ;;; Use temporary file
447 (luna-define-generic elmo-folder-message-make-temp-file-p (folder)
448 "Return t if the messages in the FOLDER makes local temporary file.")
450 (luna-define-generic elmo-folder-message-make-temp-files (folder
454 "Make a new temporary files from the messages in the FOLDER with NUMBERS.
455 If START-NUMBER is specified, temporary files begin from the number.
456 Otherwise, same number is used for temporary files.
457 Return newly created temporary directory name which contains temporary files.")
459 (luna-define-generic elmo-message-file-p (folder number)
460 "Return t if message in the FOLDER with NUMBER is a file.")
462 (luna-define-generic elmo-message-flags (folder number)
463 "Return a list of flags.
464 FOLDER is a ELMO folder structure.
465 NUMBER is a number of the message.")
467 (luna-define-method elmo-message-flag-available-p ((folder elmo-folder) number
469 (elmo-msgdb-flag-available-p (elmo-folder-msgdb folder) flag))
471 (luna-define-method elmo-message-flags ((folder elmo-folder) number)
472 (elmo-msgdb-flags (elmo-folder-msgdb folder) number))
474 (defsubst elmo-message-flagged-p (folder number flag)
475 "Return non-nil if the message is set FLAG.
476 FOLDER is a ELMO folder structure.
477 NUMBER is a message number to test."
478 (let ((cur-flags (elmo-message-flags folder number)))
481 (not (memq 'unread cur-flags)))
483 (memq flag cur-flags)))))
485 (luna-define-generic elmo-find-fetch-strategy
486 (folder entity &optional ignore-cache)
487 ;; Returns the message fetching strategy suitable for the message.
488 ;; FOLDER is the ELMO folder structure.
489 ;; ENTITY is the overview entity of the message in the folder.
490 ;; If optional argument IGNORE-CACHE is non-nil, cache is ignored.
491 ;; Returned value is a elmo-fetch-strategy object.
492 ;; If return value is nil, message should not be nil.
495 (defmacro elmo-make-fetch-strategy (entireness
500 ;; Make elmo-message-fetching strategy.
501 ;; ENTIRENESS is 'entire or 'section.
502 ;; 'entire means fetch message entirely at once.
503 ;; 'section means fetch message section by section.
504 ;; If optional USE-CACHE is non-nil, existing cache is used and otherwise,
505 ;; existing cache is thrown away.
506 ;; If SAVE-CACHE is non-nil, fetched message is saved.
507 ;; CACHE-PATH is the cache path to be used as a message cache file.
508 (` (vector (, entireness)
509 (, use-cache) (, save-cache) (, cache-path))))
511 (defmacro elmo-fetch-strategy-entireness (strategy)
512 ;; Return entireness of STRATEGY.
513 (` (aref (, strategy) 0)))
515 (defmacro elmo-fetch-strategy-use-cache (strategy)
516 ;; Return use-cache of STRATEGY.
517 (` (aref (, strategy) 1)))
519 (defmacro elmo-fetch-strategy-save-cache (strategy)
520 ;; Return save-cache of STRATEGY.
521 (` (aref (, strategy) 2)))
523 (defmacro elmo-fetch-strategy-cache-path (strategy)
524 ;; Return cache-path of STRATEGY.
525 (` (aref (, strategy) 3)))
527 (luna-define-method elmo-find-fetch-strategy
528 ((folder elmo-folder) entity &optional ignore-cache)
529 (let (cache-file size message-id number)
530 (setq size (elmo-message-entity-field entity 'size))
531 (setq message-id (elmo-message-entity-field entity 'message-id))
532 (setq number (elmo-message-entity-number entity))
533 (setq cache-file (elmo-file-cache-get message-id))
534 (setq ignore-cache (or ignore-cache
535 (null (elmo-message-use-cache-p folder number))))
537 (null (elmo-file-cache-status cache-file)))
538 ;; No cache or ignore-cache.
539 (if (and (not (elmo-folder-local-p folder))
540 elmo-message-fetch-threshold
542 (>= size elmo-message-fetch-threshold)
543 (or (not elmo-message-fetch-confirm)
544 (not (prog1 (y-or-n-p
545 (format "Fetch entire message(%dbytes)? "
548 ;; Don't fetch message at all.
550 ;; Don't use existing cache and fetch entire message at once.
551 (elmo-make-fetch-strategy
553 (elmo-message-use-cache-p folder number)
554 (elmo-file-cache-path cache-file)))
556 (if (not ignore-cache)
557 (elmo-make-fetch-strategy
559 ;; ...But ignore current section cache and re-fetch
561 (not (eq (elmo-file-cache-status cache-file) 'section))
563 (elmo-message-use-cache-p folder number)
564 (elmo-file-cache-path cache-file))))))
566 (luna-define-method elmo-folder-list-messages-internal
567 ((folder elmo-folder) &optional visible-only)
570 (defun elmo-folder-encache (folder numbers &optional unread)
571 "Encache messages in the FOLDER with NUMBERS.
572 If UNREAD is non-nil, messages are not flaged as read."
573 (dolist (number numbers)
574 (elmo-message-encache folder number unread)))
576 (luna-define-generic elmo-message-encache (folder number &optional read)
577 "Encache message in the FOLDER with NUMBER.
578 If READ is non-nil, message is flaged as read.")
580 (luna-define-method elmo-message-encache ((folder elmo-folder) number
585 (elmo-make-fetch-strategy 'entire
588 (setq path (elmo-file-cache-get-path
590 folder number 'message-id))))
594 (luna-define-generic elmo-message-fetch-bodystructure (folder number strategy)
595 "Fetch bodystructure of the message in FOLDER with NUMBER using STRATEGY.")
597 (luna-define-generic elmo-message-fetch (folder number strategy
602 "Fetch a message and return as a string.
603 FOLDER is the ELMO folder structure.
604 NUMBER is the number of the message in the FOLDER.
605 STRATEGY is the message fetching strategy.
606 If optional argument SECTION is specified, only the SECTION of the message
607 is fetched (if possible).
608 If second optional argument OUTBUF is specified, fetched message is
609 inserted to the buffer and returns t if fetch was ended successfully.
610 If third optional argument UNREAD is non-nil, message is not flaged as read.
611 Returns non-nil if fetching was succeed.")
613 (luna-define-generic elmo-message-fetch-with-cache-process (folder
618 "Fetch a message into current buffer with cache process.
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.")
627 (luna-define-generic elmo-message-fetch-internal (folder number strategy
631 "Fetch a message into current buffer.
632 FOLDER is the ELMO folder structure.
633 NUMBER is the number of the message in the FOLDER.
634 STRATEGY is the message fetching strategy.
635 If optional argument SECTION is specified, only the SECTION of the message
636 is fetched (if possible).
637 If second optional argument UNREAD is non-nil, message is not flaged as read.
638 Returns non-nil if fetching was succeed.")
640 (luna-define-generic elmo-message-fetch-field (folder number field)
641 "Fetch a message field value.
642 FOLDER is the ELMO folder structure.
643 NUMBER is the number of the message in the FOLDER.
644 FIELD is a symbol of the field name.")
646 (luna-define-generic elmo-message-folder (folder number)
647 "Get primitive folder of the message.")
649 (luna-define-generic elmo-folder-process-crosspost (folder)
650 "Process crosspost for FOLDER.
651 Return a cons cell of (NUMBER-CROSSPOSTS . NEW-FLAG-ALIST).")
653 (luna-define-generic elmo-folder-newsgroups (folder)
654 "Return list of newsgroup name of FOLDER.")
656 (luna-define-generic elmo-folder-search-requires-msgdb-p (folder condition)
657 "Return non-nil if searching in FOLDER by CONDITION requires msgdb fetch.")
659 (defun elmo-folder-search-requires-msgdb-p-internal (folder condition)
660 (if (listp condition)
661 (or (elmo-folder-search-requires-msgdb-p-internal
662 folder (nth 1 condition))
663 (elmo-folder-search-requires-msgdb-p-internal
664 folder (nth 2 condition)))
665 (and (not (string= (elmo-filter-key condition) "last"))
666 (not (string= (elmo-filter-key condition) "first")))))
668 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder elmo-folder)
670 (elmo-folder-search-requires-msgdb-p-internal folder condition))
672 (luna-define-method elmo-folder-newsgroups ((folder elmo-folder))
675 (luna-define-method elmo-folder-open ((folder elmo-folder)
676 &optional load-msgdb)
677 (elmo-generic-folder-open folder load-msgdb))
679 (defun elmo-generic-folder-open (folder load-msgdb)
680 (let ((inhibit-quit t))
681 (if load-msgdb (elmo-folder-msgdb folder))
682 (elmo-folder-set-killed-list-internal
684 (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder))))
685 (elmo-folder-open-internal folder))
687 (luna-define-method elmo-folder-open-internal ((folder elmo-folder))
688 nil ; default is do nothing.
691 (luna-define-method elmo-folder-check ((folder elmo-folder))
692 nil) ; default is noop.
694 (luna-define-method elmo-folder-commit ((folder elmo-folder))
695 (elmo-generic-folder-commit folder))
697 (defun elmo-generic-folder-commit (folder)
698 (let ((msgdb (elmo-folder-msgdb-internal folder)))
699 (when (and msgdb (elmo-folder-persistent-p folder))
700 (when (elmo-msgdb-message-modified-p msgdb)
701 (elmo-folder-set-info-max-by-numdb
703 (elmo-folder-list-messages folder nil 'in-msgdb))
704 (elmo-msgdb-killed-list-save
705 (elmo-folder-msgdb-path folder)
706 (elmo-folder-killed-list-internal folder)))
707 (elmo-msgdb-save msgdb))))
709 (luna-define-method elmo-folder-close-internal ((folder elmo-folder))
713 (luna-define-method elmo-folder-close ((folder elmo-folder))
714 (elmo-generic-folder-close folder)
715 (elmo-folder-close-internal folder))
717 (defun elmo-generic-folder-close (folder)
718 (elmo-folder-commit folder)
719 (elmo-folder-set-msgdb-internal folder nil)
720 (elmo-folder-set-killed-list-internal folder nil))
722 (luna-define-method elmo-folder-plugged-p ((folder elmo-folder))
723 t) ; default is plugged.
725 (luna-define-method elmo-folder-set-plugged ((folder elmo-folder) plugged
727 nil) ; default is do nothing.
729 (luna-define-method elmo-folder-use-flag-p ((folder elmo-folder))
730 nil) ; default is no flag.
732 (luna-define-method elmo-folder-persistent-p ((folder elmo-folder))
733 (elmo-folder-persistent-internal folder))
735 (luna-define-method elmo-folder-creatable-p ((folder elmo-folder))
736 nil) ; default is not creatable.
738 (luna-define-method elmo-folder-writable-p ((folder elmo-folder))
739 nil) ; default is not writable.
741 (luna-define-method elmo-folder-delete ((folder elmo-folder))
742 (when (yes-or-no-p (format "Delete msgdb of \"%s\"? "
743 (elmo-folder-name-internal folder)))
744 (elmo-msgdb-delete-path folder)
747 (luna-define-method elmo-folder-rename ((folder elmo-folder) new-name)
748 (let* ((new-folder (elmo-make-folder new-name)))
749 (unless (eq (elmo-folder-type-internal folder)
750 (elmo-folder-type-internal new-folder))
751 (error "Not same folder type"))
752 (if (or (file-exists-p (elmo-folder-msgdb-path new-folder))
753 (elmo-folder-exists-p new-folder))
754 (error "Already exists folder: %s" new-name))
755 (elmo-folder-send folder 'elmo-folder-rename-internal new-folder)
756 (elmo-msgdb-rename-path folder new-folder)))
758 (luna-define-method elmo-folder-search ((folder elmo-folder)
761 (let ((numbers (or numbers (elmo-folder-list-messages folder)))
762 (msgdb (elmo-folder-msgdb folder))
764 (setq results (elmo-msgdb-search msgdb condition numbers))
767 (let ((len (length numbers))
769 (elmo-with-progress-display (> len elmo-display-progress-threshold)
770 (elmo-folder-search len "Searching...")
771 (dolist (number numbers)
773 (setq result (elmo-msgdb-match-condition msgdb
777 (when (elmo-filter-condition-p result)
778 (setq result (elmo-message-match-condition folder
783 (setq matched (cons number matched))))
784 (elmo-progress-notify 'elmo-folder-search)))
785 (message "Searching...done")
786 (nreverse matched)))))
788 (luna-define-method elmo-message-match-condition ((folder elmo-folder)
791 (let* (cache cache-path
793 ((elmo-message-file-name folder number))
795 (setq cache (elmo-file-cache-get
796 (elmo-message-field folder number
798 (setq cache-path (elmo-file-cache-path cache))
800 (not (elmo-cache-path-section-p cache-path))))
802 (when (and filename (file-readable-p filename))
804 (set-buffer-multibyte nil)
805 ;;(insert-file-contents-as-binary filename)
806 (elmo-message-fetch folder number
807 (elmo-make-fetch-strategy 'entire
811 nil (current-buffer) t)
812 (set-buffer-multibyte default-enable-multibyte-characters)
813 (decode-coding-region (point-min) (point-max)
814 elmo-mime-display-as-is-coding-system)
815 (elmo-buffer-field-condition-match condition number numbers)))))
817 (luna-define-method elmo-folder-pack-numbers ((folder elmo-folder))
818 nil) ; default is noop.
820 (luna-define-method elmo-folder-update-number ((folder elmo-folder))
821 nil) ; default is noop.
823 (luna-define-method elmo-folder-message-file-p ((folder elmo-folder))
824 nil) ; default is not file.
826 (luna-define-method elmo-folder-message-file-number-p ((folder elmo-folder))
827 nil) ; default is not number.
829 (luna-define-method elmo-folder-message-make-temp-file-p ((folder elmo-folder))
830 nil) ; default is not make temp file.
832 (luna-define-method elmo-message-file-name ((folder elmo-folder)
834 nil) ; default is no name.
836 (luna-define-method elmo-folder-local-p ((folder elmo-folder))
837 t) ; default is local.
839 (luna-define-method elmo-folder-have-subfolder-p ((folder elmo-folder))
843 (luna-define-generic elmo-folder-flag-table (folder &optional if-exists)
844 "Return the flag-table of FOLDER.
845 If optional argument IF-EXISTS is nil, load on demand.
846 \(For internal use only.\)")
848 (luna-define-generic elmo-folder-close-flag-table (folder)
849 "Close flag-table of FOLDER.")
851 (luna-define-method elmo-folder-flag-table ((folder elmo-folder)
853 (or (elmo-folder-flag-table-internal folder)
855 (elmo-folder-set-flag-table-internal
857 (elmo-flag-table-load (elmo-folder-msgdb-path folder))))))
859 (luna-define-method elmo-folder-close-flag-table ((folder elmo-folder))
860 (elmo-flag-table-save (elmo-folder-msgdb-path folder)
861 (elmo-folder-flag-table folder))
862 (elmo-folder-set-flag-table-internal folder nil))
864 (defun elmo-folder-preserve-flags (folder msgid flags)
865 "Preserve FLAGS into FOLDER for a message that has MSGID."
866 (when (and msgid flags)
867 (let ((flag-table (elmo-folder-flag-table folder 'if-exists))
869 (when (setq load-now (null flag-table))
870 (setq flag-table (elmo-folder-flag-table folder)))
871 (elmo-flag-table-set flag-table msgid flags)
873 (elmo-folder-close-flag-table folder)))))
876 ;; Folder info is a message number information cache (hashtable)
877 (defsubst elmo-folder-get-info (folder &optional hashtb)
878 "Return FOLDER info from HASHTB (default is `elmo-folder-info-hashtb')."
879 (elmo-get-hash-val (elmo-folder-name-internal folder)
880 (or hashtb elmo-folder-info-hashtb)))
882 (defun elmo-folder-set-info-hashtb (folder max numbers &optional new unread)
883 "Set FOLDER info (means MAX, NUMBERS, NEW and UNREAD)."
884 (let ((info (elmo-folder-get-info folder)))
886 (or new (setq new (nth 0 info)))
887 (or unread (setq unread (nth 1 info)))
888 (or numbers (setq numbers (nth 2 info)))
889 (or max (setq max (nth 3 info))))
890 (elmo-set-hash-val (elmo-folder-name-internal folder)
891 (list new unread numbers max)
892 elmo-folder-info-hashtb)))
894 (defun elmo-folder-set-info-max-by-numdb (folder numbers)
895 "Set FOLDER info by MSGDB-NUMBER in msgdb."
896 (elmo-folder-set-info-hashtb
898 (if numbers (apply #'max numbers) 0)
899 nil ;;(length num-db)
902 (defun elmo-folder-get-info-max (folder)
903 "Return max number of FODLER from folder info."
904 (nth 3 (elmo-folder-get-info folder)))
906 (defun elmo-folder-get-info-length (folder)
907 "Return length of FODLER from folder info."
908 (nth 2 (elmo-folder-get-info folder)))
910 (defun elmo-folder-get-info-unread (folder)
911 "Return unread of FODLER from folder info."
912 (nth 1 (elmo-folder-get-info folder)))
914 (defun elmo-folder-info-make-hashtb (info-alist hashtb)
915 "Setup folder info hashtable by INFO-ALIST on HASHTB."
916 (let* ((hashtb (or hashtb
917 (elmo-make-hash (length info-alist)))))
920 (let ((info (cadr x)))
921 (and (intern-soft (car x) hashtb)
922 (elmo-set-hash-val (car x)
923 (list (nth 2 info) ;; new
924 (nth 3 info) ;; unread
925 (nth 1 info) ;; length
929 (setq elmo-folder-info-hashtb hashtb)))
931 (defsubst elmo-diff-new (diff)
934 (defsubst elmo-diff-unread (diff)
935 (when (consp (cdr diff))
938 (defsubst elmo-diff-all (diff)
939 (if (consp (cdr diff))
943 (defsubst elmo-strict-folder-diff (folder)
944 "Return folder diff information strictly from FOLDER."
945 (let ((in-db (sort (elmo-folder-list-messages folder nil 'in-msgdb) '<))
946 (in-folder (elmo-folder-list-messages folder))
947 append-list delete-list diff)
948 (cons (if (equal in-folder in-db)
950 (setq diff (elmo-list-diff in-folder in-db nil))
951 (setq append-list (car diff))
952 (setq delete-list (cadr diff))
956 (- 0 (length delete-list))
958 (length in-folder))))
960 (luna-define-method elmo-folder-diff ((folder elmo-folder))
961 (elmo-generic-folder-diff folder))
963 (defun elmo-generic-folder-diff (folder)
964 (if (elmo-string-match-member (elmo-folder-name-internal folder)
965 elmo-strict-diff-folder-list)
966 (elmo-strict-folder-diff folder)
967 (let ((cached-in-db-max (elmo-folder-get-info-max folder))
968 (in-folder (elmo-folder-status folder))
972 (if (not cached-in-db-max)
973 (let ((number-list (elmo-folder-list-messages folder
976 (setq in-db number-list)
977 (setq in-db-max (if in-db (apply #'max in-db) 0))
978 (elmo-folder-set-info-hashtb folder in-db-max nil))
979 (setq in-db-max cached-in-db-max))
980 (setq unsync (if (and in-db (car in-folder))
981 (- (car in-folder) in-db-max)
982 (if (and in-folder (null in-db))
985 (setq messages (cdr in-folder))
986 (if (and unsync messages (> unsync messages))
987 (setq unsync messages))
988 (cons (or unsync 0) (or messages 0)))))
990 (defvar elmo-folder-diff-async-callback nil)
991 (defvar elmo-folder-diff-async-callback-data nil)
993 (luna-define-method elmo-folder-diff-async ((folder elmo-folder))
994 (and elmo-folder-diff-async-callback
995 (funcall elmo-folder-diff-async-callback
997 (elmo-folder-diff folder))))
999 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-folder))
1002 (luna-define-method elmo-folder-contains-type ((folder elmo-folder) type)
1003 (eq (elmo-folder-type-internal folder) type))
1005 (luna-define-method elmo-folder-next-message-number ((folder elmo-folder))
1006 (+ 1 (elmo-max-of-list (or (elmo-folder-list-messages folder)
1009 (luna-define-method elmo-folder-append-messages ((folder elmo-folder)
1014 (elmo-generic-folder-append-messages folder src-folder numbers
1017 (defun elmo-generic-folder-append-messages (folder src-folder numbers
1019 (let ((src-msgdb-exists (not (zerop (elmo-folder-length src-folder))))
1021 succeed-numbers failure cache id)
1022 (setq table (elmo-folder-flag-table folder))
1024 (set-buffer-multibyte nil)
1027 id (and src-msgdb-exists
1028 (elmo-message-field src-folder (car numbers)
1031 (setq cache (elmo-file-cache-get id)
1036 src-folder (car numbers)
1037 (if (elmo-folder-plugged-p src-folder)
1038 (elmo-make-fetch-strategy
1040 (and cache (elmo-file-cache-path cache)))
1041 (or (and elmo-enable-disconnected-operation
1043 (eq (elmo-file-cache-status cache) 'entire)
1044 (elmo-make-fetch-strategy
1046 (elmo-file-cache-path cache)))
1047 (error "Unplugged")))
1048 nil (current-buffer)
1051 (elmo-folder-append-buffer
1053 (let ((this-id (elmo-message-field src-folder (car numbers)
1057 (elmo-msgdb-get-message-id-from-buffer))
1058 (or (elmo-message-flags src-folder (car numbers))
1060 (if same-number (car numbers))))))
1061 (error (setq failure t)))
1062 ;; FETCH & APPEND finished
1064 (setq succeed-numbers (cons (car numbers) succeed-numbers)))
1065 (elmo-progress-notify 'elmo-folder-move-messages)
1066 (setq numbers (cdr numbers)))
1067 (when (elmo-folder-persistent-p folder)
1068 (elmo-folder-close-flag-table folder))
1071 ;; Arguments should be reduced.
1072 (defun elmo-folder-move-messages (src-folder msgs dst-folder
1077 (let* ((messages msgs)
1078 (elmo-inhibit-display-retrieval-progress t)
1081 (if (eq dst-folder 'null)
1082 (setq succeeds messages)
1083 (unless (elmo-folder-writable-p dst-folder)
1084 (error "move: %d is not writable"
1085 (elmo-folder-name-internal dst-folder)))
1087 ;; src is already opened.
1088 (elmo-folder-open-internal dst-folder)
1089 (unless (setq succeeds (elmo-folder-append-messages dst-folder
1093 (error "move: append message to %s failed"
1094 (elmo-folder-name-internal dst-folder)))
1095 (elmo-folder-close dst-folder)))
1096 (if (and (not no-delete) succeeds)
1098 (if (and (elmo-folder-delete-messages src-folder succeeds)
1099 (elmo-folder-detach-messages src-folder succeeds))
1101 (elmo-global-flag-detach-messages
1102 src-folder succeeds (eq dst-folder 'null))
1104 (message "move: delete messages from %s failed."
1105 (elmo-folder-name-internal src-folder))
1110 ;; (message "Copying messages...done")
1113 (message "No message was moved.")
1114 (message "Moving messages failed.")
1118 (defun elmo-folder-msgdb-path (folder)
1119 "Return the msgdb path for FOLDER."
1120 (or (elmo-folder-path-internal folder)
1121 (elmo-folder-set-path-internal
1123 (elmo-folder-expand-msgdb-path folder))))
1125 (luna-define-generic elmo-message-cached-p (folder number)
1126 "Return non-nil if the message is cached.")
1128 (luna-define-method elmo-message-cached-p ((folder elmo-folder) number)
1129 (elmo-message-flagged-p folder number 'cached))
1131 (defun elmo-message-accessible-p (folder number)
1132 "Get accessibility of the message.
1133 Return non-nil when message is accessible."
1134 (or (elmo-folder-plugged-p folder)
1135 (elmo-folder-local-p folder)
1136 (elmo-message-cached-p folder number)))
1138 (luna-define-generic elmo-message-set-cached (folder number cached)
1139 "Set cache status of the message in the msgdb.
1140 FOLDER is the ELMO folder structure.
1141 NUMBER is a number of the message.
1142 If CACHED is t, message is set as cached.")
1144 (luna-define-method elmo-message-set-cached ((folder elmo-folder)
1147 (elmo-msgdb-set-flag (elmo-folder-msgdb folder) number 'cached)
1148 (elmo-msgdb-unset-flag (elmo-folder-msgdb folder) number 'cached)))
1150 (defun elmo-message-copy-entity (entity)
1151 (elmo-msgdb-copy-message-entity (elmo-message-entity-handler entity)
1154 (luna-define-generic elmo-message-number (folder message-id)
1155 "Get message number from MSGDB which corresponds to MESSAGE-ID.")
1157 (luna-define-method elmo-message-number ((folder elmo-folder) message-id)
1158 (elmo-msgdb-message-number (elmo-folder-msgdb folder) message-id))
1160 (luna-define-generic elmo-message-entity (folder key)
1161 "Return the message-entity structure which matches to the KEY.
1162 KEY is a number or a string.
1163 A number is for message number in the FOLDER.
1164 A string is for message-id of the message.")
1166 (luna-define-method elmo-message-entity ((folder elmo-folder) key)
1167 (elmo-msgdb-message-entity (elmo-folder-msgdb folder) key))
1169 (luna-define-generic elmo-message-entity-parent (folder entity)
1170 "Return the parent message-entity structure in the FOLDER.
1171 ENTITY is the message-entity to get the parent.")
1173 (luna-define-method elmo-message-entity-parent ((folder elmo-folder) entity)
1174 (elmo-msgdb-get-parent-entity entity (elmo-folder-msgdb folder)))
1176 (put 'elmo-folder-do-each-message-entity 'lisp-indent-function '1)
1177 (def-edebug-spec elmo-folder-do-each-message-entity
1178 ((symbolp form &rest form) &rest form))
1180 (defsubst elmo-folder-list-message-entities (folder)
1181 ;; List all message entities in the FOLDER.
1183 (lambda (number) (elmo-message-entity folder number))
1184 (elmo-folder-list-messages folder nil t))) ; XXX killed-list is not used.
1186 (defmacro elmo-folder-do-each-message-entity (spec &rest form)
1187 "Iterator for message entity in the folder.
1188 \(elmo-folder-do-each-message-entity \(entity folder\)
1189 ... do the process using entity...
1191 `(dolist (,(car spec) (elmo-folder-list-message-entities ,(car (cdr spec))))
1194 (luna-define-generic elmo-folder-count-flags (folder)
1195 "Count flagged message number in the msgdb of the FOLDER.
1196 Return alist of flag and numbers.
1200 \(answered . 3\)\)")
1202 (luna-define-method elmo-folder-count-flags ((folder elmo-folder))
1203 (elmo-msgdb-flag-count (elmo-folder-msgdb folder)))
1205 (defun elmo-message-set-flag (folder number flag &optional is-local)
1207 FOLDER is a ELMO folder structure.
1208 NUMBER is a message number to set flag.
1210 FLAG is a symbol which is one of the following:
1211 `unread' (set the message as unread)
1212 `answered' (set the message as answered)
1213 `important' (set the message as important)
1215 `read' (remove new and unread flags)
1216 If optional IS-LOCAL is non-nil, update only local (not server) status."
1217 ;; XXX Transitional implementation.
1218 (elmo-folder-set-flag folder (list number) flag is-local))
1220 (defun elmo-message-unset-flag (folder number flag &optional is-local)
1221 "Unset message flag.
1222 FOLDER is a ELMO folder structure.
1223 NUMBER is a message number to set flag.
1225 FLAG is a symbol which is one of the following:
1226 `unread' (remove unread and new flag)
1227 `answered' (remove answered flag)
1228 `important' (remove important flag)
1230 `read' (set unread flag)
1231 If optional IS-LOCAL is non-nil, update only local (not server) status."
1232 ;; XXX Transitional implementation.
1233 (elmo-folder-unset-flag folder (list number) flag is-local))
1235 (luna-define-generic elmo-message-field (folder number field)
1236 "Get message field value in the msgdb.
1237 FOLDER is the ELMO folder structure.
1238 NUMBER is a number of the message.
1239 FIELD is a symbol of the field.")
1241 (luna-define-method elmo-message-field ((folder elmo-folder) number field)
1242 (elmo-msgdb-message-field (elmo-folder-msgdb folder) number field))
1244 (luna-define-generic elmo-message-set-field (folder number field value)
1245 "Set message field value in the msgdb.
1246 FOLDER is the ELMO folder structure.
1247 NUMBER is a number of the message.
1248 FIELD is a symbol of the field.
1249 VALUE is a value to set.")
1251 (luna-define-method elmo-message-set-field ((folder elmo-folder) number
1253 (elmo-message-entity-set-field (elmo-message-entity folder number)
1256 (luna-define-method elmo-message-use-cache-p ((folder elmo-folder) number)
1257 nil) ; default is not use cache.
1259 (luna-define-method elmo-message-folder ((folder elmo-folder) number)
1260 folder) ; default is folder
1262 (luna-define-method elmo-folder-set-flag ((folder elmo-folder)
1266 (when (elmo-folder-msgdb-internal folder)
1267 (dolist (number numbers)
1268 (when (elmo-global-flag-p flag)
1269 (let ((message-id (elmo-message-field folder number 'message-id)))
1270 (elmo-global-flag-set flag folder number message-id)))
1271 (elmo-msgdb-set-flag (elmo-folder-msgdb folder)
1275 (defun elmo-message-has-global-flag-p (folder number)
1276 "Return non-nil when the message in the FOLDER with NUMBER has global flag."
1277 (let ((flags (elmo-message-flags folder number))
1280 (when (and (elmo-global-flag-p (car flags))
1281 (not (memq (car flags) '(answered unread cached))))
1284 (setq flags (cdr flags)))
1287 (defun elmo-message-set-global-flags (folder number flags &optional local)
1288 "Set global flags of the message in the FOLDER with NUMBER as FLAGS.
1289 If Optional LOCAL is non-nil, don't update server flag."
1290 (dolist (flag flags)
1291 (unless (elmo-global-flag-p flag)
1292 (error "Not a global flag")))
1293 (let ((old-flags (elmo-get-global-flags (elmo-message-flags folder number))))
1294 (dolist (flag flags)
1295 (unless (memq flag old-flags)
1296 (elmo-message-set-flag folder number flag local)))
1297 (dolist (flag old-flags)
1298 (unless (memq flag flags)
1299 (elmo-message-unset-flag folder number flag local)))))
1301 (luna-define-method elmo-folder-unset-flag ((folder elmo-folder)
1305 (when (elmo-folder-msgdb-internal folder)
1306 (dolist (number numbers)
1307 (when (elmo-global-flag-p flag)
1308 (elmo-global-flag-detach flag folder number 'always))
1309 (elmo-msgdb-unset-flag (elmo-folder-msgdb folder)
1313 (luna-define-method elmo-folder-process-crosspost ((folder elmo-folder))
1317 ;;(luna-define-generic elmo-folder-append-message-entity (folder entity
1320 ;; "Append ENTITY to the folder.")
1322 (defun elmo-msgdb-merge (folder msgdb-merge)
1323 "Return a list of messages which have duplicated message-id."
1324 (let (msgdb duplicates)
1325 (setq msgdb (or (elmo-folder-msgdb-internal folder)
1326 (elmo-make-msgdb (elmo-folder-msgdb-path folder))))
1327 (setq duplicates (elmo-msgdb-append msgdb msgdb-merge))
1328 (elmo-folder-set-msgdb-internal folder msgdb)
1331 (defsubst elmo-folder-append-msgdb (folder append-msgdb)
1333 (let ((duplicates (elmo-msgdb-merge folder append-msgdb)))
1334 (cond ((eq (elmo-folder-process-duplicates-internal folder)
1336 ;; Let duplicates be a temporary killed message.
1337 (elmo-folder-kill-messages folder duplicates)
1338 ;; Should be flag as read.
1339 (elmo-folder-unset-flag folder duplicates 'unread))
1340 ((eq (elmo-folder-process-duplicates-internal folder)
1342 ;; Flag as read duplicates.
1343 (elmo-folder-unset-flag folder duplicates 'unread))
1346 (setq duplicates nil)))
1347 (length duplicates))
1350 (defun elmo-folder-confirm-appends (appends)
1351 (let ((len (length appends))
1353 (if (and elmo-folder-update-threshold
1354 (> len elmo-folder-update-threshold)
1355 elmo-folder-update-confirm)
1356 (if (y-or-n-p (format "Too many messages(%d). Update all? " len))
1358 (setq in elmo-folder-update-threshold)
1361 (setq in (read-from-minibuffer "Update number: "
1363 in (string-to-int in))
1366 (if (y-or-n-p (format
1367 "%d messages are killed (not appeared). OK? "
1368 (max (- len in) 0)))
1370 (nthcdr (max (- len in) 0) appends))
1371 (if (and elmo-folder-update-threshold
1372 (> len elmo-folder-update-threshold)
1373 (not elmo-folder-update-confirm))
1374 (nthcdr (max (- len elmo-folder-update-threshold) 0) appends)
1377 (luna-define-method elmo-message-fetch-bodystructure ((folder elmo-folder)
1381 (luna-define-method elmo-message-fetch ((folder elmo-folder)
1388 (with-current-buffer outbuf
1390 (elmo-message-fetch-with-cache-process folder number
1391 strategy section unread))
1393 (elmo-message-fetch-with-cache-process folder number
1394 strategy section unread)
1397 (luna-define-method elmo-message-fetch-with-cache-process ((folder elmo-folder)
1401 (let ((cache-path (elmo-fetch-strategy-cache-path strategy))
1403 (cond ((eq (elmo-fetch-strategy-use-cache strategy) 'maybe)
1405 ((elmo-fetch-strategy-use-cache strategy)
1410 (while (and method-priorities
1413 (case (car method-priorities)
1415 (elmo-file-cache-load cache-path section))
1417 (when (and (condition-case error
1418 (elmo-message-fetch-internal folder number
1422 (error (setq err error) nil))
1423 (> (buffer-size) 0))
1424 (when (and (elmo-fetch-strategy-save-cache strategy)
1426 (elmo-file-cache-save cache-path section))
1428 method-priorities (cdr method-priorities)))
1430 (and err (signal (car err) (cdr err))))))
1432 (defun elmo-folder-kill-messages-range (folder beg end)
1433 (elmo-folder-set-killed-list-internal
1436 (elmo-folder-killed-list-internal folder)
1437 (list (cons beg end)))))
1439 (defun elmo-folder-kill-messages (folder numbers)
1440 "Kill(hide) messages in the FOLDER with NUMBERS."
1441 (elmo-folder-set-killed-list-internal
1443 (elmo-number-set-append-list
1444 (elmo-folder-killed-list-internal folder)
1446 (elmo-folder-unset-flag folder numbers 'all 'local-only))
1448 (luna-define-method elmo-folder-clear ((folder elmo-folder)
1449 &optional keep-killed)
1451 (elmo-folder-set-killed-list-internal folder nil))
1452 (if (eq elmo-msgdb-convert-type 'sync)
1453 (elmo-folder-set-msgdb-internal
1455 (elmo-make-msgdb (elmo-folder-msgdb-path folder)))
1456 (elmo-msgdb-clear (elmo-folder-msgdb folder))))
1458 (luna-define-generic elmo-folder-synchronize (folder
1464 "Synchronize the folder data to the newest status.
1465 FOLDER is the ELMO folder structure.
1467 If optional DISABLE-KILLED is non-nil, killed messages are also synchronized.
1468 If optional IGNORE-MSGDB is non-nil, current msgdb is thrown away except
1470 If NO-CHECK is non-nil, rechecking folder is skipped.
1471 If optional argument MASK is specified and is a list of message numbers,
1472 synchronize messages only which are contained the list.
1473 Return amount of cross-posted messages.
1474 If update process is interrupted, return nil.")
1476 (luna-define-method elmo-folder-synchronize ((folder elmo-folder)
1482 (let ((killed-list (elmo-folder-killed-list-internal folder))
1484 old-msgdb diff diff-2 delete-list new-list new-msgdb flag
1485 flag-table crossed after-append)
1486 (setq old-msgdb (elmo-folder-msgdb folder))
1487 (setq flag-table (elmo-flag-table-load (elmo-folder-msgdb-path folder)))
1489 (elmo-msgdb-flag-table (elmo-folder-msgdb folder) flag-table)
1490 (elmo-folder-clear folder (not disable-killed)))
1491 (unless no-check (elmo-folder-check folder))
1494 (message "Checking folder diff...")
1495 (setq diff (elmo-list-diff (elmo-folder-list-messages
1497 (not disable-killed))
1498 (elmo-folder-list-messages
1500 (not disable-killed)
1502 (when (and mask (car diff))
1503 (setcar diff (elmo-list-filter mask (car diff))))
1504 (message "Checking folder diff...done")
1505 (setq new-list (elmo-folder-confirm-appends (car diff)))
1506 ;; Set killed list as ((1 . MAX-OF-DISAPPEARED))
1507 (when (and (not (eq (length (car diff))
1509 (setq diff-2 (elmo-list-diff (car diff) new-list)))
1510 (elmo-folder-kill-messages-range
1513 (nth (- (length (car diff-2)) 1) (car diff-2))))
1514 (setq delete-list (cadr diff))
1515 (if (or (equal diff '(nil nil))
1517 (and (eq (length (car diff)) 0)
1518 (eq (length (cadr diff)) 0)))
1520 (elmo-folder-update-number folder)
1521 (elmo-folder-process-crosspost folder)
1525 (elmo-folder-detach-messages folder delete-list))
1527 (elmo-msgdb-out-of-date-messages (elmo-folder-msgdb folder))
1528 (setq new-msgdb (elmo-folder-msgdb-create
1529 folder new-list flag-table))
1531 (if (elmo-folder-persistent-p folder)
1532 (elmo-flag-table-save (elmo-folder-msgdb-path folder)
1534 (setq before-append nil)
1535 (setq crossed (elmo-folder-append-msgdb folder new-msgdb))
1536 ;; process crosspost.
1537 ;; Return a cons cell of (NUMBER-CROSSPOSTS . NEW-FLAG-ALIST).
1538 (elmo-folder-process-crosspost folder))
1542 ;; Resume to the original status.
1543 (if before-append (elmo-folder-set-msgdb-internal folder old-msgdb))
1544 (elmo-folder-set-killed-list-internal folder killed-list)
1547 (luna-define-generic elmo-folder-detach-messages (folder numbers)
1548 "Remove messages with NUMBERS from MSGDB.")
1550 (luna-define-method elmo-folder-detach-messages ((folder elmo-folder)
1552 (elmo-msgdb-delete-messages (elmo-folder-msgdb folder) numbers))
1554 (luna-define-generic elmo-folder-length (folder)
1555 "Return number of messages in the FOLDER.")
1557 (luna-define-method elmo-folder-length ((folder elmo-folder))
1558 (if (elmo-folder-msgdb-internal folder)
1559 (elmo-msgdb-length (elmo-folder-msgdb folder))
1562 (defun elmo-folder-msgdb-load (folder &optional silent)
1564 (message "Loading msgdb for %s..." (elmo-folder-name-internal folder)))
1565 (let ((msgdb (elmo-load-msgdb (elmo-folder-msgdb-path folder))))
1566 (elmo-folder-set-info-max-by-numdb
1568 (elmo-msgdb-list-messages msgdb))
1570 (message "Loading msgdb for %s...done"
1571 (elmo-folder-name-internal folder)))
1574 (defun elmo-msgdb-delete-path (folder)
1575 (let ((path (elmo-folder-msgdb-path folder)))
1576 (if (file-directory-p path)
1577 (elmo-delete-directory path t))))
1579 (defun elmo-msgdb-rename-path (old-folder new-folder)
1580 (let* ((old (directory-file-name (elmo-folder-msgdb-path old-folder)))
1581 (new (directory-file-name (elmo-folder-msgdb-path new-folder)))
1582 (new-dir (directory-file-name (file-name-directory new))))
1583 (if (not (file-directory-p old))
1585 (if (file-exists-p new)
1586 (error "Already exists directory: %s" new)
1587 (if (not (file-exists-p new-dir))
1588 (elmo-make-directory new-dir))
1589 (rename-file old new)))))
1591 (defun elmo-setup-subscribed-newsgroups (groups)
1592 "Setup subscribed newsgroups.
1593 GROUPS is a list of newsgroup name string.
1594 Return a hashtable for newsgroups."
1595 (let ((hashtb (or elmo-newsgroups-hashtb
1596 (setq elmo-newsgroups-hashtb
1597 (elmo-make-hash (length groups))))))
1598 (dolist (group groups)
1599 (or (elmo-get-hash-val group hashtb)
1600 (elmo-set-hash-val group nil hashtb)))
1601 (setq elmo-newsgroups-hashtb hashtb)))
1603 (defvar elmo-crosspost-message-alist-modified nil)
1604 (defun elmo-crosspost-message-alist-load ()
1605 "Load crosspost message alist."
1606 (setq elmo-crosspost-message-alist (elmo-crosspost-alist-load))
1607 (setq elmo-crosspost-message-alist-modified nil))
1609 (defun elmo-crosspost-message-alist-save ()
1610 "Save crosspost message alist."
1611 (when elmo-crosspost-message-alist-modified
1612 (let ((alist elmo-crosspost-message-alist)
1618 (not (intern-soft x elmo-newsgroups-hashtb)))
1619 (nth 1 (car alist))))
1621 (setcar (cdar alist) newsgroups)
1622 (setq elmo-crosspost-message-alist
1623 (delete (car alist) elmo-crosspost-message-alist)))
1624 (setq alist (cdr alist)))
1625 (elmo-crosspost-alist-save elmo-crosspost-message-alist)
1626 (setq elmo-crosspost-message-alist-modified nil))))
1628 (defun elmo-folder-make-temporary-directory (folder)
1629 ;; Make a temporary directory for FOLDER.
1630 (let ((temp-dir (make-temp-name
1632 (file-name-as-directory (elmo-folder-msgdb-path folder))
1634 (elmo-make-directory temp-dir)
1638 "Initialize ELMO module."
1639 (elmo-crosspost-message-alist-load)
1640 (elmo-resque-obsolete-variables)
1641 (elmo-dop-queue-load)
1642 (run-hooks 'elmo-init-hook))
1645 "Quit and cleanup ELMO."
1646 (elmo-crosspost-message-alist-save)
1647 (elmo-dop-queue-save)
1648 ;; Not implemented yet.
1649 (let ((types elmo-folder-type-alist)
1654 (intern (format "elmo-%s-folder"
1655 (symbol-name (cdr (car types)))))))
1656 ;; Call all folder's `elmo-quit' method.
1658 (dolist (func (luna-class-find-functions class 'elmo-quit))
1659 (funcall func nil)))
1660 (setq types (cdr types)))))
1662 (luna-define-method elmo-folder-rename-internal ((folder elmo-folder)
1664 (error "Cannot rename %s folder"
1665 (symbol-name (elmo-folder-type-internal folder))))
1668 (elmo-define-folder ?% 'imap4)
1669 (elmo-define-folder ?- 'nntp)
1670 (elmo-define-folder ?\+ 'localdir)
1671 (elmo-define-folder ?\* 'multi)
1672 (elmo-define-folder ?\/ 'filter)
1673 (elmo-define-folder ?\$ 'archive)
1674 (elmo-define-folder ?& 'pop3)
1675 (elmo-define-folder ?= 'localnews)
1676 (elmo-define-folder ?| 'pipe)
1677 (elmo-define-folder ?. 'maildir)
1678 (elmo-define-folder ?' 'internal)
1679 (elmo-define-folder ?\[ 'nmz)
1680 (elmo-define-folder ?@ 'shimbun)
1682 ;;; Obsolete variables.
1683 (elmo-define-obsolete-variable 'elmo-default-imap4-mailbox
1684 'elmo-imap4-default-mailbox)
1685 (elmo-define-obsolete-variable 'elmo-default-imap4-server
1686 'elmo-imap4-default-server)
1687 (elmo-define-obsolete-variable 'elmo-default-imap4-authenticate-type
1688 'elmo-imap4-default-authenticate-type)
1689 (elmo-define-obsolete-variable 'elmo-default-imap4-user
1690 'elmo-imap4-default-user)
1691 (elmo-define-obsolete-variable 'elmo-default-imap4-port
1692 'elmo-imap4-default-port)
1693 (elmo-define-obsolete-variable 'elmo-default-imap4-stream-type
1694 'elmo-imap4-default-stream-type)
1695 (elmo-define-obsolete-variable 'elmo-default-nntp-server
1696 'elmo-nntp-default-server)
1697 (elmo-define-obsolete-variable 'elmo-default-nntp-user
1698 'elmo-nntp-default-user)
1699 (elmo-define-obsolete-variable 'elmo-default-nntp-port
1700 'elmo-nntp-default-port)
1701 (elmo-define-obsolete-variable 'elmo-default-nntp-stream-type
1702 'elmo-nntp-default-stream-type)
1703 (elmo-define-obsolete-variable 'elmo-default-pop3-server
1704 'elmo-pop3-default-server)
1705 (elmo-define-obsolete-variable 'elmo-default-pop3-user
1706 'elmo-pop3-default-user)
1707 (elmo-define-obsolete-variable 'elmo-default-pop3-authenticate-type
1708 'elmo-pop3-default-authenticate-type)
1709 (elmo-define-obsolete-variable 'elmo-default-pop3-port
1710 'elmo-pop3-default-port)
1711 (elmo-define-obsolete-variable 'elmo-default-pop3-stream-type
1712 'elmo-pop3-default-stream-type)
1713 (elmo-define-obsolete-variable 'elmo-cache-dirname
1714 'elmo-cache-directory)
1715 (elmo-define-obsolete-variable 'elmo-msgdb-dir
1716 'elmo-msgdb-directory)
1718 ;; Obsolete functions.
1719 ;; 2001-12-11: *-dir -> *-directory
1720 (defalias 'elmo-folder-make-temp-dir 'elmo-folder-make-temporary-directory)
1721 (make-obsolete 'elmo-folder-make-temp-dir
1722 'elmo-folder-make-temporary-directory)
1725 (product-provide (provide 'elmo) (require 'elmo-version))
1727 ;;; elmo.el ends here