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