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