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 (luna-define-method elmo-message-flag-available-p ((folder elmo-folder) number
 476                                                    flag)
 477   (elmo-msgdb-flag-available-p (elmo-folder-msgdb folder) flag))
 478
 479 (luna-define-method elmo-message-flags ((folder elmo-folder) number)
 480   (elmo-msgdb-flags (elmo-folder-msgdb folder) number))
 481
 482 (defsubst elmo-message-flagged-p (folder number flag)
 483   "Return non-nil if the message is set FLAG.
 484 FOLDER is a ELMO folder structure.
 485 NUMBER is a message number to test."
 486   (let ((cur-flags (elmo-message-flags folder number)))
 487     (case flag
 488       (read
 489        (not (memq 'unread cur-flags)))
 490       (t
 491        (memq flag cur-flags)))))
 492
 493 (luna-define-generic elmo-find-fetch-strategy
 494   (folder entity &optional ignore-cache)
 495 ;; Returns the message fetching strategy suitable for the message.
 496 ;; FOLDER is the ELMO folder structure.
 497 ;; ENTITY is the overview entity of the message in the folder.
 498 ;; If optional argument IGNORE-CACHE is non-nil, cache is ignored.
 499 ;; Returned value is a elmo-fetch-strategy object.
 500 ;; If return value is nil, message should not be nil.
 501   )
 502
 503 (defmacro elmo-make-fetch-strategy (entireness
 504                                     &optional
 505                                     use-cache
 506                                     save-cache
 507                                     cache-path)
 508 ;; Make elmo-message-fetching strategy.
 509 ;; ENTIRENESS is 'entire or 'section.
 510 ;; 'entire means fetch message entirely at once.
 511 ;; 'section means fetch message section by section.
 512 ;; If optional USE-CACHE is non-nil, existing cache is used and otherwise,
 513 ;; existing cache is thrown away.
 514 ;; If SAVE-CACHE is non-nil, fetched message is saved.
 515 ;; CACHE-PATH is the cache path to be used as a message cache file.
 516   (` (vector (, entireness)
 517              (, use-cache) (, save-cache) (, cache-path))))
 518
 519 (defmacro elmo-fetch-strategy-entireness (strategy)
 520   ;; Return entireness of STRATEGY.
 521   (` (aref (, strategy) 0)))
 522
 523 (defmacro elmo-fetch-strategy-use-cache (strategy)
 524   ;; Return use-cache of STRATEGY.
 525   (` (aref (, strategy) 1)))
 526
 527 (defmacro elmo-fetch-strategy-save-cache (strategy)
 528   ;; Return save-cache of STRATEGY.
 529   (` (aref (, strategy) 2)))
 530
 531 (defmacro elmo-fetch-strategy-cache-path (strategy)
 532   ;;  Return cache-path of STRATEGY.
 533   (` (aref (, strategy) 3)))
 534
 535 (luna-define-method elmo-find-fetch-strategy
 536   ((folder elmo-folder) entity &optional ignore-cache)
 537   (let (cache-file size message-id number)
 538     (setq size (elmo-message-entity-field entity 'size))
 539     (setq message-id (elmo-message-entity-field entity 'message-id))
 540     (setq number (elmo-message-entity-number entity))
 541     (setq cache-file (elmo-file-cache-get message-id))
 542     (setq ignore-cache (or ignore-cache
 543                            (null (elmo-message-use-cache-p folder number))))
 544     (if (or ignore-cache
 545             (null (elmo-file-cache-status cache-file)))
 546         ;; No cache or ignore-cache.
 547         (if (and (not (elmo-folder-local-p folder))
 548                  elmo-message-fetch-threshold
 549                  (integerp size)
 550                  (>= size elmo-message-fetch-threshold)
 551                  (or (not elmo-message-fetch-confirm)
 552                      (not (prog1 (y-or-n-p
 553                                   (format "Fetch entire message(%dbytes)? "
 554                                           size))
 555                             (message "")))))
 556             ;; Don't fetch message at all.
 557             nil
 558           ;; Don't use existing cache and fetch entire message at once.
 559           (elmo-make-fetch-strategy
 560            'entire nil
 561            (elmo-message-use-cache-p folder number)
 562            (elmo-file-cache-path cache-file)))
 563       ;; Cache exists.
 564       (if (not ignore-cache)
 565           (elmo-make-fetch-strategy
 566            'entire
 567            ;; ...But ignore current section cache and re-fetch
 568            ;; if section cache.
 569            (not (eq (elmo-file-cache-status cache-file) 'section))
 570            ;; Save cache.
 571            (elmo-message-use-cache-p folder number)
 572            (elmo-file-cache-path cache-file))))))
 573
 574 (luna-define-method elmo-folder-list-messages-internal
 575   ((folder elmo-folder) &optional visible-only)
 576   t)
 577
 578 (defun elmo-folder-encache (folder numbers &optional unread)
 579   "Encache messages in the FOLDER with NUMBERS.
 580 If UNREAD is non-nil, messages are not flaged as read."
 581   (dolist (number numbers)
 582     (elmo-message-encache folder number unread)))
 583
 584 (luna-define-generic elmo-message-encache (folder number &optional read)
 585   "Encache message in the FOLDER with NUMBER.
 586 If READ is non-nil, message is flaged as read.")
 587
 588 (luna-define-method elmo-message-encache ((folder elmo-folder) number
 589                                           &optional read)
 590   (let (path)
 591     (elmo-message-fetch
 592      folder number
 593      (elmo-make-fetch-strategy 'entire
 594                                nil ;use-cache
 595                                t   ;save-cache
 596                                (setq path (elmo-file-cache-get-path
 597                                            (elmo-message-field
 598                                             folder number 'message-id))))
 599      nil nil (not read))
 600     path))
 601
 602 (luna-define-generic elmo-message-fetch-bodystructure (folder number strategy)
 603   "Fetch bodystructure of the message in FOLDER with NUMBER using STRATEGY.")
 604
 605 (luna-define-generic elmo-message-fetch (folder number strategy
 606                                                 &optional
 607                                                 section
 608                                                 outbuf
 609                                                 unread)
 610   "Fetch a message and return as a string.
 611 FOLDER is the ELMO folder structure.
 612 NUMBER is the number of the message in the FOLDER.
 613 STRATEGY is the message fetching strategy.
 614 If optional argument SECTION is specified, only the SECTION of the message
 615 is fetched (if possible).
 616 If second optional argument OUTBUF is specified, fetched message is
 617 inserted to the buffer and returns t if fetch was ended successfully.
 618 If third optional argument UNREAD is non-nil, message is not flaged as read.
 619 Returns non-nil if fetching was succeed.")
 620
 621 (luna-define-generic elmo-message-fetch-with-cache-process (folder
 622                                                             number strategy
 623                                                             &optional
 624                                                             section
 625                                                             unread)
 626   "Fetch a message into current buffer with cache process.
 627 FOLDER is the ELMO folder structure.
 628 NUMBER is the number of the message in the FOLDER.
 629 STRATEGY is the message fetching strategy.
 630 If optional argument SECTION is specified, only the SECTION of the message
 631 is fetched (if possible).
 632 If second 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-internal (folder number strategy
 636                                                          &optional
 637                                                          section
 638                                                          unread)
 639   "Fetch a message into current buffer.
 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-field (folder number field)
 649   "Fetch a message field value.
 650 FOLDER is the ELMO folder structure.
 651 NUMBER is the number of the message in the FOLDER.
 652 FIELD is a symbol of the field name.")
 653
 654 (luna-define-generic elmo-message-folder (folder number)
 655   "Get primitive folder of the message.")
 656
 657 (luna-define-generic elmo-folder-process-crosspost (folder)
 658   "Process crosspost for FOLDER.
 659 Return a cons cell of (NUMBER-CROSSPOSTS . NEW-FLAG-ALIST).")
 660
 661 (luna-define-generic elmo-folder-newsgroups (folder)
 662   "Return list of newsgroup name of FOLDER.")
 663
 664 (luna-define-generic elmo-folder-search-requires-msgdb-p (folder condition)
 665   "Return non-nil if searching in FOLDER by CONDITION requires msgdb fetch.")
 666
 667 (defun elmo-folder-search-requires-msgdb-p-internal (folder condition)
 668   (if (listp condition)
 669       (or (elmo-folder-search-requires-msgdb-p-internal
 670            folder (nth 1 condition))
 671           (elmo-folder-search-requires-msgdb-p-internal
 672            folder (nth 2 condition)))
 673     (and (not (string= (elmo-filter-key condition) "last"))
 674          (not (string= (elmo-filter-key condition) "first")))))
 675
 676 (luna-define-method elmo-folder-search-requires-msgdb-p ((folder elmo-folder)
 677                                                          condition)
 678   (elmo-folder-search-requires-msgdb-p-internal folder condition))
 679
 680 (luna-define-method elmo-folder-newsgroups ((folder elmo-folder))
 681   nil)
 682
 683 (luna-define-method elmo-folder-open ((folder elmo-folder)
 684                                       &optional load-msgdb)
 685   (elmo-generic-folder-open folder load-msgdb))
 686
 687 (defun elmo-generic-folder-open (folder load-msgdb)
 688   (let ((inhibit-quit t))
 689     (if load-msgdb (elmo-folder-msgdb folder))
 690     (elmo-folder-set-killed-list-internal
 691      folder
 692      (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder))))
 693   (elmo-folder-open-internal folder))
 694
 695 (luna-define-method elmo-folder-open-internal ((folder elmo-folder))
 696   nil ; default is do nothing.
 697   )
 698
 699 (luna-define-method elmo-folder-check ((folder elmo-folder))
 700   nil) ; default is noop.
 701
 702 (luna-define-method elmo-folder-commit ((folder elmo-folder))
 703   (elmo-generic-folder-commit folder))
 704
 705 (defun elmo-generic-folder-commit (folder)
 706   (when (elmo-folder-persistent-p folder)
 707     (let ((msgdb (elmo-folder-msgdb-internal folder)))
 708       (when msgdb
 709         (when (elmo-msgdb-message-modified-p msgdb)
 710           (elmo-folder-set-info-max-by-numdb
 711            folder
 712            (elmo-folder-list-messages folder nil 'in-msgdb)))
 713         (elmo-msgdb-save msgdb)))
 714     (elmo-msgdb-killed-list-save
 715      (elmo-folder-msgdb-path folder)
 716      (elmo-folder-killed-list-internal folder))))
 717
 718 (luna-define-method elmo-folder-close-internal ((folder elmo-folder))
 719   ;; do nothing.
 720   )
 721
 722 (luna-define-method elmo-folder-close ((folder elmo-folder))
 723   (elmo-generic-folder-close folder)
 724   (elmo-folder-close-internal folder))
 725
 726 (defun elmo-generic-folder-close (folder)
 727   (elmo-folder-commit folder)
 728   (elmo-folder-set-msgdb-internal folder nil)
 729   (elmo-folder-set-killed-list-internal folder nil))
 730
 731 (luna-define-method elmo-folder-plugged-p ((folder elmo-folder))
 732   t) ; default is plugged.
 733
 734 (luna-define-method elmo-folder-set-plugged ((folder elmo-folder) plugged
 735                                              &optional add)
 736   nil) ; default is do nothing.
 737
 738 (luna-define-method elmo-folder-use-flag-p ((folder elmo-folder))
 739   nil) ; default is no flag.
 740
 741 (luna-define-method elmo-folder-persistent-p ((folder elmo-folder))
 742   (elmo-folder-persistent-internal folder))
 743
 744 (luna-define-method elmo-folder-creatable-p ((folder elmo-folder))
 745   nil) ; default is not creatable.
 746
 747 (luna-define-method elmo-folder-writable-p ((folder elmo-folder))
 748   nil) ; default is not writable.
 749
 750 (luna-define-method elmo-folder-delete ((folder elmo-folder))
 751   (when (yes-or-no-p (format "Delete msgdb of \"%s\"? "
 752                              (elmo-folder-name-internal folder)))
 753     (elmo-msgdb-delete-path folder)
 754     t))
 755
 756 (luna-define-method elmo-folder-rename ((folder elmo-folder) new-name)
 757   (let* ((new-folder (elmo-make-folder new-name)))
 758     (unless (eq (elmo-folder-type-internal folder)
 759                 (elmo-folder-type-internal new-folder))
 760       (error "Not same folder type"))
 761     (if (or (file-exists-p (elmo-folder-msgdb-path new-folder))
 762             (elmo-folder-exists-p new-folder))
 763         (error "Already exists folder: %s" new-name))
 764     (elmo-folder-send folder 'elmo-folder-rename-internal new-folder)
 765     (elmo-msgdb-rename-path folder new-folder)))
 766
 767 (luna-define-method elmo-folder-delete-messages ((folder elmo-folder)
 768                                                  numbers)
 769   (and (elmo-folder-delete-messages-internal folder numbers)
 770        (elmo-folder-detach-messages folder numbers)))
 771
 772 (luna-define-method elmo-folder-search ((folder elmo-folder)
 773                                         condition
 774                                         &optional numbers)
 775   (let ((numbers (or numbers (elmo-folder-list-messages folder)))
 776         (msgdb (elmo-folder-msgdb folder))
 777         results)
 778     (setq results (elmo-msgdb-search msgdb condition numbers))
 779     (if (listp results)
 780         results
 781       (let ((len (length numbers))
 782             matched)
 783         (elmo-with-progress-display (> len elmo-display-progress-threshold)
 784             (elmo-folder-search len "Searching...")
 785           (dolist (number numbers)
 786             (let (result)
 787               (setq result (elmo-msgdb-match-condition msgdb
 788                                                        condition
 789                                                        number
 790                                                        numbers))
 791               (when (elmo-filter-condition-p result)
 792                 (setq result (elmo-message-match-condition folder
 793                                                            number
 794                                                            condition
 795                                                            numbers)))
 796               (when result
 797                 (setq matched (cons number matched))))
 798             (elmo-progress-notify 'elmo-folder-search)))
 799         (message "Searching...done")
 800         (nreverse matched)))))
 801
 802 (luna-define-method elmo-message-match-condition ((folder elmo-folder)
 803                                                   number condition
 804                                                   numbers)
 805   (let* (cache cache-path
 806          (filename (cond
 807                     ((elmo-message-file-name folder number))
 808                     ((progn
 809                        (setq cache (elmo-file-cache-get
 810                                     (elmo-message-field folder number
 811                                                         'message-id)))
 812                        (setq cache-path (elmo-file-cache-path cache))
 813                        (and cache-path
 814                             (not (elmo-cache-path-section-p cache-path))))
 815                      cache-path))))
 816     (when (and filename (file-readable-p filename))
 817       (with-temp-buffer
 818         (set-buffer-multibyte nil)
 819         ;;(insert-file-contents-as-binary filename)
 820         (elmo-message-fetch folder number
 821                             (elmo-make-fetch-strategy 'entire
 822                                                       (and cache t)
 823                                                       nil
 824                                                       cache-path)
 825                             nil (current-buffer) t)
 826         (set-buffer-multibyte default-enable-multibyte-characters)
 827         (decode-coding-region (point-min) (point-max)
 828                               elmo-mime-display-as-is-coding-system)
 829         (elmo-buffer-field-condition-match condition number numbers)))))
 830
 831 (luna-define-method elmo-folder-pack-numbers ((folder elmo-folder))
 832   nil) ; default is noop.
 833
 834 (luna-define-method elmo-folder-update-number ((folder elmo-folder))
 835   nil) ; default is noop.
 836
 837 (luna-define-method elmo-folder-message-file-p ((folder elmo-folder))
 838   nil) ; default is not file.
 839
 840 (luna-define-method elmo-folder-message-file-number-p ((folder elmo-folder))
 841   nil) ; default is not number.
 842
 843 (luna-define-method elmo-folder-message-make-temp-file-p ((folder elmo-folder))
 844   nil) ; default is not make temp file.
 845
 846 (luna-define-method elmo-message-file-name ((folder elmo-folder)
 847                                                    number)
 848   nil) ; default is no name.
 849
 850 (luna-define-method elmo-folder-local-p ((folder elmo-folder))
 851   t)   ; default is local.
 852
 853 (luna-define-method elmo-folder-have-subfolder-p ((folder elmo-folder))
 854   t)
 855
 856 ;; Flag table
 857 (luna-define-generic elmo-folder-flag-table (folder &optional if-exists)
 858   "Return the flag-table of FOLDER.
 859 If optional argument IF-EXISTS is nil, load on demand.
 860 \(For internal use only.\)")
 861
 862 (luna-define-generic elmo-folder-close-flag-table (folder)
 863   "Close flag-table of FOLDER.")
 864
 865 (luna-define-method elmo-folder-flag-table ((folder elmo-folder)
 866                                             &optional if-exists)
 867   (or (elmo-folder-flag-table-internal folder)
 868       (unless if-exists
 869         (elmo-folder-set-flag-table-internal
 870          folder
 871          (elmo-flag-table-load (elmo-folder-msgdb-path folder))))))
 872
 873 (luna-define-method elmo-folder-close-flag-table ((folder elmo-folder))
 874   (elmo-flag-table-save (elmo-folder-msgdb-path folder)
 875                         (elmo-folder-flag-table folder))
 876   (elmo-folder-set-flag-table-internal folder nil))
 877
 878 (defun elmo-folder-preserve-flags (folder msgid flags)
 879   "Preserve FLAGS into FOLDER for a message that has MSGID."
 880   (when (and msgid flags)
 881     (let ((flag-table (elmo-folder-flag-table folder 'if-exists))
 882           load-now)
 883       (when (setq load-now (null flag-table))
 884         (setq flag-table (elmo-folder-flag-table folder)))
 885       (elmo-flag-table-set flag-table msgid flags)
 886       (when load-now
 887         (elmo-folder-close-flag-table folder)))))
 888
 889 ;;; Folder info
 890 ;; Folder info is a message number information cache (hashtable)
 891 (defsubst elmo-folder-get-info (folder &optional hashtb)
 892   "Return FOLDER info from HASHTB (default is `elmo-folder-info-hashtb')."
 893   (elmo-get-hash-val (elmo-folder-name-internal folder)
 894                      (or hashtb elmo-folder-info-hashtb)))
 895
 896 (defun elmo-folder-set-info-hashtb (folder max numbers &optional new unread)
 897   "Set FOLDER info (means MAX, NUMBERS, NEW and UNREAD)."
 898   (let ((info (elmo-folder-get-info folder)))
 899     (when info
 900       (or new     (setq new     (nth 0 info)))
 901       (or unread  (setq unread  (nth 1 info)))
 902       (or numbers (setq numbers (nth 2 info)))
 903       (or max     (setq max     (nth 3 info))))
 904     (elmo-set-hash-val (elmo-folder-name-internal folder)
 905                        (list new unread numbers max)
 906                        elmo-folder-info-hashtb)))
 907
 908 (defun elmo-folder-set-info-max-by-numdb (folder numbers)
 909   "Set FOLDER info by MSGDB-NUMBER in msgdb."
 910   (elmo-folder-set-info-hashtb
 911    folder
 912    (if numbers (apply #'max numbers) 0)
 913    nil ;;(length num-db)
 914    ))
 915
 916 (defun elmo-folder-get-info-max (folder)
 917   "Return max number of FODLER from folder info."
 918   (nth 3 (elmo-folder-get-info folder)))
 919
 920 (defun elmo-folder-get-info-length (folder)
 921   "Return length of FODLER from folder info."
 922   (nth 2 (elmo-folder-get-info folder)))
 923
 924 (defun elmo-folder-get-info-unread (folder)
 925   "Return unread of FODLER from folder info."
 926   (nth 1 (elmo-folder-get-info folder)))
 927
 928 (defun elmo-folder-info-make-hashtb (info-alist hashtb)
 929   "Setup folder info hashtable by INFO-ALIST on HASHTB."
 930   (let* ((hashtb (or hashtb
 931                      (elmo-make-hash (length info-alist)))))
 932     (mapcar
 933      (lambda (x)
 934        (let ((info (cadr x)))
 935          (and (intern-soft (car x) hashtb)
 936               (elmo-set-hash-val (car x)
 937                                  (list (nth 2 info)   ;; new
 938                                        (nth 3 info)   ;; unread
 939                                        (nth 1 info)   ;; length
 940                                        (nth 0 info))  ;; max
 941                                  hashtb))))
 942      info-alist)
 943     (setq elmo-folder-info-hashtb hashtb)))
 944
 945 (defsubst elmo-diff-new (diff)
 946   (car diff))
 947
 948 (defsubst elmo-diff-unread (diff)
 949   (when (consp (cdr diff))
 950     (nth 1 diff)))
 951
 952 (defsubst elmo-diff-all (diff)
 953   (if (consp (cdr diff))
 954       (nth 2 diff)
 955     (cdr diff)))
 956
 957 (defsubst elmo-strict-folder-diff (folder)
 958   "Return folder diff information strictly from FOLDER."
 959   (let ((in-db (sort (elmo-folder-list-messages folder nil 'in-msgdb) '<))
 960         (in-folder  (elmo-folder-list-messages folder))
 961         append-list delete-list diff)
 962     (cons (if (equal in-folder in-db)
 963               0
 964             (setq diff (elmo-list-diff in-folder in-db nil))
 965             (setq append-list (car diff))
 966             (setq delete-list (cadr diff))
 967             (if append-list
 968                 (length append-list)
 969               (if delete-list
 970                   (- 0 (length delete-list))
 971                 0)))
 972           (length in-folder))))
 973
 974 (luna-define-method elmo-folder-diff ((folder elmo-folder))
 975   (elmo-generic-folder-diff folder))
 976
 977 (defun elmo-generic-folder-diff (folder)
 978   (if (elmo-string-match-member (elmo-folder-name-internal folder)
 979                                 elmo-strict-diff-folder-list)
 980       (elmo-strict-folder-diff folder)
 981     (let ((cached-in-db-max (elmo-folder-get-info-max folder))
 982           (in-folder (elmo-folder-status folder))
 983           (in-db t)
 984           unsync messages
 985           in-db-max)
 986       (if (not cached-in-db-max)
 987           (let ((number-list (elmo-folder-list-messages folder
 988                                                         nil 'in-msgdb)))
 989             ;; No info-cache.
 990             (setq in-db number-list)
 991             (setq in-db-max (if in-db (apply #'max in-db) 0))
 992             (elmo-folder-set-info-hashtb folder in-db-max nil))
 993         (setq in-db-max cached-in-db-max))
 994       (setq unsync (if (and in-db (car in-folder))
 995                        (- (car in-folder) in-db-max)
 996                      (if (and in-folder (null in-db))
 997                          (cdr in-folder)
 998                        (car in-folder))))
 999       (setq messages (cdr in-folder))
1000       (if (and unsync messages (> unsync messages))
1001           (setq unsync messages))
1002       (cons (or unsync 0) (or messages 0)))))
1003
1004 (defvar elmo-folder-diff-async-callback nil)
1005 (defvar elmo-folder-diff-async-callback-data nil)
1006
1007 (luna-define-method elmo-folder-diff-async ((folder elmo-folder))
1008   (and elmo-folder-diff-async-callback
1009        (funcall elmo-folder-diff-async-callback
1010                 folder
1011                 (elmo-folder-diff folder))))
1012
1013 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-folder))
1014   (list folder))
1015
1016 (luna-define-method elmo-folder-contains-type ((folder elmo-folder) type)
1017   (eq (elmo-folder-type-internal folder) type))
1018
1019 (luna-define-method elmo-folder-next-message-number ((folder elmo-folder))
1020   (+ 1 (elmo-max-of-list (or (elmo-folder-list-messages folder)
1021                              '(0)))))
1022
1023 (luna-define-method elmo-folder-append-messages ((folder elmo-folder)
1024                                                  src-folder
1025                                                  numbers
1026                                                  &optional
1027                                                  same-number)
1028   (elmo-generic-folder-append-messages folder src-folder numbers
1029                                        same-number))
1030
1031 (defun elmo-generic-folder-append-messages (folder src-folder numbers
1032                                                    same-number)
1033   (let ((src-msgdb-exists (not (zerop (elmo-folder-length src-folder))))
1034         unseen table
1035         succeed-numbers failure cache id)
1036     (setq table (elmo-folder-flag-table folder))
1037     (with-temp-buffer
1038       (set-buffer-multibyte nil)
1039       (while numbers
1040         (setq failure nil
1041               id (and src-msgdb-exists
1042                       (elmo-message-field src-folder (car numbers)
1043                                           'message-id)))
1044         (condition-case nil
1045             (setq cache (elmo-file-cache-get id)
1046                   failure
1047                   (not
1048                    (and
1049                     (elmo-message-fetch
1050                      src-folder (car numbers)
1051                      (if (elmo-folder-plugged-p src-folder)
1052                          (elmo-make-fetch-strategy
1053                           'entire 'maybe nil
1054                           (and cache (elmo-file-cache-path cache)))
1055                        (or (and elmo-enable-disconnected-operation
1056                                 cache
1057                                 (eq (elmo-file-cache-status cache) 'entire)
1058                                 (elmo-make-fetch-strategy
1059                                  'entire t nil
1060                                  (elmo-file-cache-path cache)))
1061                            (error "Unplugged")))
1062                      nil (current-buffer)
1063                      'unread)
1064                     (> (buffer-size) 0)
1065                     (elmo-folder-append-buffer
1066                      folder
1067                      (let ((this-id (elmo-message-field src-folder (car numbers)
1068                                                         'message-id)))
1069                        (and this-id
1070                             (string= this-id
1071                                      (elmo-msgdb-get-message-id-from-buffer))
1072                             (or (elmo-message-flags src-folder (car numbers))
1073                                 '(read))))
1074                      (if same-number (car numbers))))))
1075           (error (setq failure t)))
1076         ;; FETCH & APPEND finished
1077         (unless failure
1078           (setq succeed-numbers (cons (car numbers) succeed-numbers)))
1079         (elmo-progress-notify 'elmo-folder-move-messages)
1080         (setq numbers (cdr numbers)))
1081       (when (elmo-folder-persistent-p folder)
1082         (elmo-folder-close-flag-table folder))
1083       succeed-numbers)))
1084
1085 ;; Arguments should be reduced.
1086 (defun elmo-folder-move-messages (src-folder msgs dst-folder
1087                                              &optional
1088                                              no-delete
1089                                              same-number)
1090   (save-excursion
1091     (let* ((messages msgs)
1092            (elmo-inhibit-display-retrieval-progress t)
1093            (len (length msgs))
1094            succeeds i result)
1095       (if (eq dst-folder 'null)
1096           (setq succeeds messages)
1097         (unless (elmo-folder-writable-p dst-folder)
1098           (error "move: %d is not writable"
1099                  (elmo-folder-name-internal dst-folder)))
1100         (when messages
1101           ;; src is already opened.
1102           (elmo-folder-open-internal dst-folder)
1103           (unless (setq succeeds (elmo-folder-append-messages dst-folder
1104                                                               src-folder
1105                                                               messages
1106                                                               same-number))
1107             (error "move: append message to %s failed"
1108                    (elmo-folder-name-internal dst-folder)))
1109           (elmo-folder-close dst-folder)))
1110       (if (and (not no-delete) succeeds)
1111           (progn
1112             (if (elmo-folder-delete-messages src-folder succeeds)
1113                 (progn
1114                   (elmo-global-flag-detach-messages
1115                    src-folder succeeds (eq dst-folder 'null))
1116                   (setq result t))
1117               (message "move: delete messages from %s failed."
1118                        (elmo-folder-name-internal src-folder))
1119               (setq result nil))
1120             result)
1121         (if no-delete
1122             (progn
1123               ;; (message "Copying messages...done")
1124               t)
1125           (if (eq len 0)
1126               (message "No message was moved.")
1127             (message "Moving messages failed.")
1128             nil ; failure
1129             ))))))
1130
1131 (defun elmo-folder-msgdb-path (folder)
1132   "Return the msgdb path for FOLDER."
1133   (or (elmo-folder-path-internal folder)
1134       (elmo-folder-set-path-internal
1135        folder
1136        (elmo-folder-expand-msgdb-path folder))))
1137
1138 (luna-define-generic elmo-message-cached-p (folder number)
1139   "Return non-nil if the message is cached.")
1140
1141 (luna-define-method elmo-message-cached-p ((folder elmo-folder) number)
1142   (elmo-message-flagged-p folder number 'cached))
1143
1144 (defun elmo-message-accessible-p (folder number)
1145   "Get accessibility of the message.
1146 Return non-nil when message is accessible."
1147   (or (elmo-folder-plugged-p folder)
1148       (elmo-folder-local-p folder)
1149       (elmo-message-cached-p folder number)))
1150
1151 (luna-define-generic elmo-message-set-cached (folder number cached)
1152   "Set cache status of the message in the msgdb.
1153 FOLDER is the ELMO folder structure.
1154 NUMBER is a number of the message.
1155 If CACHED is t, message is set as cached.")
1156
1157 (luna-define-method elmo-message-set-cached ((folder elmo-folder)
1158                                              number cached)
1159   (if cached
1160       (elmo-msgdb-set-flag (elmo-folder-msgdb folder) number 'cached)
1161     (elmo-msgdb-unset-flag (elmo-folder-msgdb folder) number 'cached)))
1162
1163 (defun elmo-message-copy-entity (entity)
1164   (elmo-msgdb-copy-message-entity (elmo-message-entity-handler entity)
1165                                   entity))
1166
1167 (luna-define-generic elmo-message-number (folder message-id)
1168   "Get message number from MSGDB which corresponds to MESSAGE-ID.")
1169
1170 (luna-define-method elmo-message-number ((folder elmo-folder) message-id)
1171   (elmo-msgdb-message-number (elmo-folder-msgdb folder) message-id))
1172
1173 (luna-define-generic elmo-message-entity (folder key)
1174   "Return the message-entity structure which matches to the KEY.
1175 KEY is a number or a string.
1176 A number is for message number in the FOLDER.
1177 A string is for message-id of the message.")
1178
1179 (luna-define-method elmo-message-entity ((folder elmo-folder) key)
1180   (elmo-msgdb-message-entity (elmo-folder-msgdb folder) key))
1181
1182 (luna-define-generic elmo-message-entity-parent (folder entity)
1183   "Return the parent message-entity structure in the FOLDER.
1184 ENTITY is the message-entity to get the parent.")
1185
1186 (luna-define-method elmo-message-entity-parent ((folder elmo-folder) entity)
1187   (elmo-msgdb-get-parent-entity entity (elmo-folder-msgdb folder)))
1188
1189 (put 'elmo-folder-do-each-message-entity 'lisp-indent-function '1)
1190 (def-edebug-spec elmo-folder-do-each-message-entity
1191   ((symbolp form &rest form) &rest form))
1192
1193 (defsubst elmo-folder-list-message-entities (folder)
1194   ;; List all message entities in the FOLDER.
1195   (mapcar
1196    (lambda (number) (elmo-message-entity folder number))
1197    (elmo-folder-list-messages folder nil t))) ; XXX killed-list is not used.
1198
1199 (defmacro elmo-folder-do-each-message-entity (spec &rest form)
1200   "Iterator for message entity in the folder.
1201 \(elmo-folder-do-each-message-entity \(entity folder\)
1202  ... do the process using entity...
1203 \)"
1204   `(dolist (,(car spec) (elmo-folder-list-message-entities ,(car (cdr spec))))
1205      ,@form))
1206
1207 (luna-define-generic elmo-folder-count-flags (folder)
1208   "Count flagged message number in the msgdb of the FOLDER.
1209 Return alist of flag and numbers.
1210 Example:
1211 \(\(new . 10\)
1212   \(unread . 20\)
1213   \(answered . 3\)\)")
1214
1215 (luna-define-method elmo-folder-count-flags ((folder elmo-folder))
1216   (elmo-msgdb-flag-count (elmo-folder-msgdb folder)))
1217
1218 (defun elmo-message-set-flag (folder number flag &optional is-local)
1219   "Set message flag.
1220 FOLDER is a ELMO folder structure.
1221 NUMBER is a message number to set flag.
1222
1223 FLAG is a symbol which is one of the following:
1224   `unread'    (set the message as unread)
1225   `answered'  (set the message as answered)
1226   `important' (set the message as important)
1227 'sugar' flag:
1228   `read'      (remove new and unread flags)
1229 If optional IS-LOCAL is non-nil, update only local (not server) status."
1230   ;; XXX Transitional implementation.
1231   (elmo-folder-set-flag folder (list number) flag is-local))
1232
1233 (defun elmo-message-unset-flag (folder number flag &optional is-local)
1234   "Unset message flag.
1235 FOLDER is a ELMO folder structure.
1236 NUMBER is a message number to set flag.
1237
1238 FLAG is a symbol which is one of the following:
1239   `unread'    (remove unread and new flag)
1240   `answered'  (remove answered flag)
1241   `important' (remove important flag)
1242 'sugar' flag:
1243   `read'      (set unread flag)
1244 If optional IS-LOCAL is non-nil, update only local (not server) status."
1245   ;; XXX Transitional implementation.
1246   (elmo-folder-unset-flag folder (list number) flag is-local))
1247
1248 (luna-define-generic elmo-message-field (folder number field)
1249   "Get message field value in the msgdb.
1250 FOLDER is the ELMO folder structure.
1251 NUMBER is a number of the message.
1252 FIELD is a symbol of the field.")
1253
1254 (luna-define-method elmo-message-field ((folder elmo-folder) number field)
1255   (elmo-msgdb-message-field (elmo-folder-msgdb folder) number field))
1256
1257 (luna-define-generic elmo-message-set-field (folder number field value)
1258   "Set message field value in the msgdb.
1259 FOLDER is the ELMO folder structure.
1260 NUMBER is a number of the message.
1261 FIELD is a symbol of the field.
1262 VALUE is a value to set.")
1263
1264 (luna-define-method elmo-message-set-field ((folder elmo-folder) number
1265                                             field value)
1266   (elmo-message-entity-set-field (elmo-message-entity folder number)
1267                                  field value))
1268
1269 (luna-define-method elmo-message-use-cache-p ((folder elmo-folder) number)
1270   nil) ; default is not use cache.
1271
1272 (luna-define-method elmo-message-folder ((folder elmo-folder) number)
1273   folder) ; default is folder
1274
1275 (luna-define-method elmo-folder-set-flag ((folder elmo-folder)
1276                                           numbers
1277                                           flag
1278                                           &optional is-local)
1279   (when (elmo-folder-msgdb-internal folder)
1280     (dolist (number numbers)
1281       (when (elmo-global-flag-p flag)
1282         (let ((message-id (elmo-message-field folder number 'message-id)))
1283           (elmo-global-flag-set flag folder number message-id)))
1284       (elmo-msgdb-set-flag (elmo-folder-msgdb folder)
1285                            number
1286                            flag))
1287     (elmo-folder-notify-event folder 'flag-changed numbers)))
1288
1289 (defun elmo-message-has-global-flag-p (folder number)
1290   "Return non-nil when the message in the FOLDER with NUMBER has global flag."
1291   (let ((flags (elmo-message-flags folder number))
1292         result)
1293     (while flags
1294       (when (and (elmo-global-flag-p (car flags))
1295                  (not (memq (car flags) '(answered unread cached))))
1296         (setq result t
1297               flags nil))
1298       (setq flags (cdr flags)))
1299     result))
1300
1301 (defun elmo-message-set-global-flags (folder number flags &optional local)
1302   "Set global flags of the message in the FOLDER with NUMBER as FLAGS.
1303 If Optional LOCAL is non-nil, don't update server flag."
1304   (dolist (flag flags)
1305     (unless (elmo-global-flag-p flag)
1306       (error "Not a global flag")))
1307   (let ((old-flags (elmo-get-global-flags (elmo-message-flags folder number))))
1308     (dolist (flag flags)
1309       (unless (memq flag old-flags)
1310         (elmo-message-set-flag folder number flag local)))
1311     (dolist (flag old-flags)
1312       (unless (memq flag flags)
1313         (elmo-message-unset-flag folder number flag local)))))
1314
1315 (luna-define-method elmo-folder-unset-flag ((folder elmo-folder)
1316                                             numbers
1317                                             flag
1318                                             &optional is-local)
1319   (when (elmo-folder-msgdb-internal folder)
1320     (dolist (number numbers)
1321       (when (elmo-global-flag-p flag)
1322         (elmo-global-flag-detach flag folder number 'always))
1323       (elmo-msgdb-unset-flag (elmo-folder-msgdb folder)
1324                              number
1325                              flag))
1326     (elmo-folder-notify-event folder 'flag-changed numbers)))
1327
1328 (luna-define-method elmo-folder-process-crosspost ((folder elmo-folder))
1329   ;; Do nothing.
1330   )
1331
1332 ;;(luna-define-generic elmo-folder-append-message-entity (folder entity
1333 ;;                                                             &optional
1334 ;;                                                             flag-table)
1335 ;;  "Append ENTITY to the folder.")
1336
1337 (defun elmo-msgdb-merge (folder msgdb-merge)
1338   "Return a list of messages which have duplicated message-id."
1339   (let (msgdb duplicates)
1340     (setq msgdb (or (elmo-folder-msgdb-internal folder)
1341                     (elmo-make-msgdb (elmo-folder-msgdb-path folder))))
1342     (setq duplicates (elmo-msgdb-append msgdb msgdb-merge))
1343     (elmo-folder-set-msgdb-internal folder msgdb)
1344     duplicates))
1345
1346 (defsubst elmo-folder-append-msgdb (folder append-msgdb)
1347   (if append-msgdb
1348       (let ((duplicates (elmo-msgdb-merge folder append-msgdb)))
1349         (cond ((eq (elmo-folder-process-duplicates-internal folder)
1350                    'hide)
1351                ;; Let duplicates be a temporary killed message.
1352                (elmo-folder-kill-messages folder duplicates)
1353                ;; Should be flag as read.
1354                (elmo-folder-unset-flag folder duplicates 'unread))
1355               ((eq (elmo-folder-process-duplicates-internal folder)
1356                    'read)
1357                ;; Flag as read duplicates.
1358                (elmo-folder-unset-flag folder duplicates 'unread))
1359               (t
1360                ;; Do nothing.
1361                (setq duplicates nil)))
1362         (length duplicates))
1363     0))
1364
1365 (defun elmo-folder-confirm-appends (appends)
1366   (let ((len (length appends))
1367         in)
1368     (if (and elmo-folder-update-threshold
1369              (> len elmo-folder-update-threshold)
1370              elmo-folder-update-confirm)
1371         (if (y-or-n-p (format "Too many messages(%d).  Update all? " len))
1372             appends
1373           (setq in elmo-folder-update-threshold)
1374           (catch 'end
1375             (while t
1376               (setq in (read-from-minibuffer "Update number: "
1377                                              (int-to-string in))
1378                     in (string-to-int in))
1379               (if (< len in)
1380                   (throw 'end len))
1381               (if (y-or-n-p (format
1382                              "%d messages are killed (not appeared). OK? "
1383                              (max (- len in) 0)))
1384                   (throw 'end in))))
1385           (nthcdr (max (- len in) 0) appends))
1386       (if (and elmo-folder-update-threshold
1387                (> len elmo-folder-update-threshold)
1388                (not elmo-folder-update-confirm))
1389           (nthcdr (max (- len elmo-folder-update-threshold) 0) appends)
1390         appends))))
1391
1392 (luna-define-method elmo-message-fetch-bodystructure ((folder elmo-folder)
1393                                                       number strategy)
1394   nil)
1395
1396 (luna-define-method elmo-message-fetch ((folder elmo-folder)
1397                                         number strategy
1398                                         &optional
1399                                         section
1400                                         outbuf
1401                                         unread)
1402   (if outbuf
1403       (with-current-buffer outbuf
1404         (erase-buffer)
1405         (elmo-message-fetch-with-cache-process folder number
1406                                                strategy section unread))
1407     (with-temp-buffer
1408       (elmo-message-fetch-with-cache-process folder number
1409                                              strategy section unread)
1410       (buffer-string))))
1411
1412 (luna-define-method elmo-message-fetch-with-cache-process ((folder elmo-folder)
1413                                                            number strategy
1414                                                            &optional
1415                                                            section unread)
1416   (let ((cache-path (elmo-fetch-strategy-cache-path strategy))
1417         (method-priorities
1418          (cond ((eq (elmo-fetch-strategy-use-cache strategy) 'maybe)
1419                 '(entity cache))
1420                ((elmo-fetch-strategy-use-cache strategy)
1421                 '(cache entity))
1422                (t
1423                 '(entity))))
1424         result err)
1425     (while (and method-priorities
1426                 (null result))
1427       (setq result
1428             (case (car method-priorities)
1429               (cache
1430                (elmo-file-cache-load cache-path section))
1431               (entity
1432                (when (and (condition-case error
1433                               (elmo-message-fetch-internal folder number
1434                                                            strategy
1435                                                            section
1436                                                            unread)
1437                             (error (setq err error) nil))
1438                           (> (buffer-size) 0))
1439                  (when (and (elmo-fetch-strategy-save-cache strategy)
1440                             cache-path)
1441                    (elmo-file-cache-save cache-path section))
1442                  t)))
1443             method-priorities (cdr method-priorities)))
1444     (or result
1445         (and err (signal (car err) (cdr err))))))
1446
1447 (defun elmo-folder-kill-messages-range (folder beg end)
1448   (elmo-folder-set-killed-list-internal
1449    folder
1450    (nconc
1451     (elmo-folder-killed-list-internal folder)
1452     (list (cons beg end)))))
1453
1454 (defun elmo-folder-kill-messages (folder numbers)
1455   "Kill(hide) messages in the FOLDER with NUMBERS."
1456   (elmo-folder-set-killed-list-internal
1457    folder
1458    (elmo-number-set-append-list
1459     (elmo-folder-killed-list-internal folder)
1460     numbers))
1461   (elmo-folder-unset-flag folder numbers 'all 'local-only))
1462
1463 (luna-define-method elmo-folder-clear ((folder elmo-folder)
1464                                        &optional keep-killed)
1465   (unless keep-killed
1466     (elmo-folder-set-killed-list-internal folder nil))
1467   (if (eq elmo-msgdb-convert-type 'sync)
1468       (elmo-folder-set-msgdb-internal
1469        folder
1470        (elmo-make-msgdb (elmo-folder-msgdb-path folder)))
1471     (elmo-msgdb-clear (elmo-folder-msgdb folder))))
1472
1473 (luna-define-generic elmo-folder-synchronize (folder
1474                                               &optional
1475                                               disable-killed
1476                                               ignore-msgdb
1477                                               no-check
1478                                               mask)
1479   "Synchronize the folder data to the newest status.
1480 FOLDER is the ELMO folder structure.
1481
1482 If optional DISABLE-KILLED is non-nil, killed messages are also synchronized.
1483 If optional IGNORE-MSGDB is non-nil, current msgdb is thrown away except
1484 flag status.
1485 If NO-CHECK is non-nil, rechecking folder is skipped.
1486 If optional argument MASK is specified and is a list of message numbers,
1487 synchronize messages only which are contained the list.
1488 Return amount of cross-posted messages.
1489 If update process is interrupted, return nil.")
1490
1491 (luna-define-method elmo-folder-synchronize ((folder elmo-folder)
1492                                              &optional
1493                                              disable-killed
1494                                              ignore-msgdb
1495                                              no-check
1496                                              mask)
1497   (let ((old-msgdb (elmo-folder-msgdb folder))
1498         (killed-list (elmo-folder-killed-list-internal folder))
1499         (flag-table (elmo-flag-table-load (elmo-folder-msgdb-path folder)))
1500         (before-append t))
1501     (when ignore-msgdb
1502       (elmo-msgdb-flag-table (elmo-folder-msgdb folder) flag-table)
1503       (elmo-folder-clear folder (not disable-killed)))
1504     (unless no-check (elmo-folder-check folder))
1505     (condition-case nil
1506         (let ((killed-list (elmo-folder-killed-list-internal folder))
1507               diff-new diff-del
1508               delete-list new-list new-msgdb crossed)
1509           (message "Checking folder diff...")
1510           (elmo-set-list
1511            '(diff-new diff-del)
1512            (elmo-list-diff (elmo-folder-list-messages folder)
1513                            (elmo-folder-list-messages folder nil 'in-msgdb)))
1514           (when diff-new
1515             (unless disable-killed
1516               (setq diff-new (elmo-living-messages diff-new killed-list)))
1517             (when mask
1518               (setq diff-new (elmo-list-filter mask diff-new))))
1519           (message "Checking folder diff...done")
1520           (setq new-list (elmo-folder-confirm-appends diff-new))
1521           ;; Append to killed list as (MIN-OF-DISAPPEARED . MAX-OF-DISAPPEARED)
1522           (when (not (eq (length diff-new)
1523                          (length new-list)))
1524             (let* ((diff (elmo-list-diff diff-new new-list))
1525                    (disappeared (car diff)))
1526               (when disappeared
1527                 (elmo-folder-kill-messages-range folder
1528                                                  (car disappeared)
1529                                                  (elmo-last disappeared)))))
1530           (setq delete-list diff-del)
1531           (if (and (null diff-new) (null diff-del))
1532               (progn
1533                 (elmo-folder-update-number folder)
1534                 (elmo-folder-process-crosspost folder)
1535                 0)                      ; `0' means no updates.
1536             (when delete-list
1537               (elmo-folder-detach-messages folder delete-list))
1538             (when new-list
1539               (elmo-msgdb-out-of-date-messages (elmo-folder-msgdb folder))
1540               (setq new-msgdb (elmo-folder-msgdb-create
1541                                folder new-list flag-table))
1542               ;; Clear flag-table
1543               (if (elmo-folder-persistent-p folder)
1544                   (elmo-flag-table-save (elmo-folder-msgdb-path folder)
1545                                         nil))
1546               (setq before-append nil)
1547               (setq crossed (elmo-folder-append-msgdb folder new-msgdb))
1548               ;; process crosspost.
1549               ;; Return a cons cell of (NUMBER-CROSSPOSTS . NEW-FLAG-ALIST).
1550               (elmo-folder-process-crosspost folder))
1551             ;; return value.
1552             (or crossed 0)))
1553       (quit
1554        ;; Resume to the original status.
1555        (if before-append (elmo-folder-set-msgdb-internal folder old-msgdb))
1556        (elmo-folder-set-killed-list-internal folder killed-list)
1557        nil))))
1558
1559 (luna-define-generic elmo-folder-detach-messages (folder numbers)
1560   "Remove messages with NUMBERS from MSGDB.")
1561
1562 (luna-define-method elmo-folder-detach-messages ((folder elmo-folder)
1563                                                  numbers)
1564   (when (elmo-msgdb-delete-messages (elmo-folder-msgdb folder) numbers)
1565     ;; Remove NUMBERS from killed message list.
1566     (elmo-folder-set-killed-list-internal
1567      folder
1568      (elmo-number-set-delete-list
1569       (elmo-folder-killed-list-internal folder)
1570       numbers))
1571     t))
1572
1573 (luna-define-generic elmo-folder-length (folder)
1574   "Return number of messages in the FOLDER.")
1575
1576 (luna-define-method elmo-folder-length ((folder elmo-folder))
1577   (if (elmo-folder-msgdb-internal folder)
1578       (elmo-msgdb-length (elmo-folder-msgdb folder))
1579     0))
1580
1581 (defun elmo-folder-msgdb-load (folder &optional silent)
1582   (unless silent
1583     (message "Loading msgdb for %s..." (elmo-folder-name-internal folder)))
1584   (let ((msgdb (elmo-load-msgdb (elmo-folder-msgdb-path folder))))
1585     (elmo-folder-set-info-max-by-numdb
1586      folder
1587      (elmo-msgdb-list-messages msgdb))
1588     (unless silent
1589       (message "Loading msgdb for %s...done"
1590                (elmo-folder-name-internal folder)))
1591     msgdb))
1592
1593 (defun elmo-msgdb-delete-path (folder)
1594   (let ((path (elmo-folder-msgdb-path folder)))
1595     (if (file-directory-p path)
1596         (elmo-delete-directory path t))))
1597
1598 (defun elmo-msgdb-rename-path (old-folder new-folder)
1599   (let* ((old (directory-file-name (elmo-folder-msgdb-path old-folder)))
1600          (new (directory-file-name (elmo-folder-msgdb-path new-folder)))
1601          (new-dir (directory-file-name (file-name-directory new))))
1602     (if (not (file-directory-p old))
1603         ()
1604       (if (file-exists-p new)
1605           (error "Already exists directory: %s" new)
1606         (if (not (file-exists-p new-dir))
1607             (elmo-make-directory new-dir))
1608         (rename-file old new)))))
1609
1610 (defun elmo-setup-subscribed-newsgroups (groups)
1611   "Setup subscribed newsgroups.
1612 GROUPS is a list of newsgroup name string.
1613 Return a hashtable for newsgroups."
1614   (let ((hashtb (or elmo-newsgroups-hashtb
1615                     (setq elmo-newsgroups-hashtb
1616                           (elmo-make-hash (length groups))))))
1617     (dolist (group groups)
1618       (or (elmo-get-hash-val group hashtb)
1619           (elmo-set-hash-val group nil hashtb)))
1620     (setq elmo-newsgroups-hashtb hashtb)))
1621
1622 (defvar elmo-crosspost-message-alist-modified nil)
1623 (defun elmo-crosspost-message-alist-load ()
1624   "Load crosspost message alist."
1625   (setq elmo-crosspost-message-alist (elmo-crosspost-alist-load))
1626   (setq elmo-crosspost-message-alist-modified nil))
1627
1628 (defun elmo-crosspost-message-alist-save ()
1629   "Save crosspost message alist."
1630   (when elmo-crosspost-message-alist-modified
1631     (let ((alist elmo-crosspost-message-alist)
1632           newsgroups)
1633       (while alist
1634         (setq newsgroups
1635               (elmo-delete-if
1636                '(lambda (x)
1637                   (not (intern-soft x elmo-newsgroups-hashtb)))
1638                (nth 1 (car alist))))
1639         (if newsgroups
1640             (setcar (cdar alist) newsgroups)
1641           (setq elmo-crosspost-message-alist
1642                 (delete (car alist) elmo-crosspost-message-alist)))
1643         (setq alist (cdr alist)))
1644       (elmo-crosspost-alist-save elmo-crosspost-message-alist)
1645       (setq elmo-crosspost-message-alist-modified nil))))
1646
1647 (defun elmo-folder-make-temporary-directory (folder)
1648   ;; Make a temporary directory for FOLDER.
1649   (let ((temp-dir (make-temp-name
1650                    (concat
1651                     (file-name-as-directory (elmo-folder-msgdb-path folder))
1652                     "elmo"))))
1653     (elmo-make-directory temp-dir)
1654     temp-dir))
1655
1656 ;; Event notification/observer framework
1657 (eval-and-compile
1658   (luna-define-class elmo-event-handler ()))
1659
1660 (luna-define-generic elmo-event-handler-flag-changed (handler numbers)
1661   "Notify flag of the messages with NUMBERS is changed.")
1662
1663 (defun elmo-folder-add-handler (folder handler)
1664   (unless (memq handler (elmo-folder-handlers-internal folder))
1665     (elmo-folder-set-handlers-internal
1666      folder
1667      (cons handler (elmo-folder-handlers-internal folder)))))
1668
1669 (defun elmo-folder-remove-handler (folder handler)
1670   (elmo-folder-set-handlers-internal
1671    folder
1672    (delq handler (elmo-folder-handlers-internal folder))))
1673
1674 (defun elmo-folder-notify-event (folder event &rest args)
1675   (when (elmo-folder-handlers-internal folder)
1676     (let ((message (format "elmo-event-handler-%s" event)))
1677       (dolist (handler (elmo-folder-handlers-internal folder))
1678         (apply #'luna-send handler message handler args)))))
1679
1680 ;;;
1681 (defun elmo-init ()
1682   "Initialize ELMO module."
1683   (elmo-crosspost-message-alist-load)
1684   (elmo-resque-obsolete-variables)
1685   (elmo-dop-queue-load)
1686   (run-hooks 'elmo-init-hook))
1687
1688 (defun elmo-quit ()
1689   "Quit and cleanup ELMO."
1690   (elmo-crosspost-message-alist-save)
1691   (elmo-dop-queue-save)
1692   ;; Not implemented yet.
1693   (let ((types elmo-folder-type-alist)
1694         class)
1695     (while types
1696       (setq class
1697             (luna-find-class
1698              (intern (format "elmo-%s-folder"
1699                              (symbol-name (cdr (car types)))))))
1700       ;; Call all folder's `elmo-quit' method.
1701       (if class
1702           (dolist (func (luna-class-find-functions class 'elmo-quit))
1703             (funcall func nil)))
1704       (setq types (cdr types)))))
1705
1706 (luna-define-method elmo-folder-rename-internal ((folder elmo-folder)
1707                                                  new-folder)
1708   (error "Cannot rename %s folder"
1709          (symbol-name (elmo-folder-type-internal folder))))
1710
1711 ;;; Define folders.
1712 (elmo-define-folder ?% 'imap4)
1713 (elmo-define-folder ?-  'nntp)
1714 (elmo-define-folder ?\+ 'localdir)
1715 (elmo-define-folder ?\* 'multi)
1716 (elmo-define-folder ?\/ 'filter)
1717 (elmo-define-folder ?\$ 'archive)
1718 (elmo-define-folder ?&  'pop3)
1719 (elmo-define-folder ?=  'localnews)
1720 (elmo-define-folder ?|  'pipe)
1721 (elmo-define-folder ?.  'maildir)
1722 (elmo-define-folder ?'  'internal)
1723 (elmo-define-folder ?\[  'nmz)
1724 (elmo-define-folder ?@  'shimbun)
1725
1726 ;;; Obsolete variables.
1727 (elmo-define-obsolete-variable 'elmo-default-imap4-mailbox
1728                                'elmo-imap4-default-mailbox)
1729 (elmo-define-obsolete-variable 'elmo-default-imap4-server
1730                                'elmo-imap4-default-server)
1731 (elmo-define-obsolete-variable 'elmo-default-imap4-authenticate-type
1732                                'elmo-imap4-default-authenticate-type)
1733 (elmo-define-obsolete-variable 'elmo-default-imap4-user
1734                                'elmo-imap4-default-user)
1735 (elmo-define-obsolete-variable 'elmo-default-imap4-port
1736                                'elmo-imap4-default-port)
1737 (elmo-define-obsolete-variable 'elmo-default-imap4-stream-type
1738                                'elmo-imap4-default-stream-type)
1739 (elmo-define-obsolete-variable 'elmo-default-nntp-server
1740                                'elmo-nntp-default-server)
1741 (elmo-define-obsolete-variable 'elmo-default-nntp-user
1742                                'elmo-nntp-default-user)
1743 (elmo-define-obsolete-variable 'elmo-default-nntp-port
1744                                'elmo-nntp-default-port)
1745 (elmo-define-obsolete-variable 'elmo-default-nntp-stream-type
1746                                'elmo-nntp-default-stream-type)
1747 (elmo-define-obsolete-variable 'elmo-default-pop3-server
1748                                'elmo-pop3-default-server)
1749 (elmo-define-obsolete-variable 'elmo-default-pop3-user
1750                                'elmo-pop3-default-user)
1751 (elmo-define-obsolete-variable 'elmo-default-pop3-authenticate-type
1752                                'elmo-pop3-default-authenticate-type)
1753 (elmo-define-obsolete-variable 'elmo-default-pop3-port
1754                                'elmo-pop3-default-port)
1755 (elmo-define-obsolete-variable 'elmo-default-pop3-stream-type
1756                                'elmo-pop3-default-stream-type)
1757 (elmo-define-obsolete-variable 'elmo-cache-dirname
1758                                'elmo-cache-directory)
1759 (elmo-define-obsolete-variable 'elmo-msgdb-dir
1760                                'elmo-msgdb-directory)
1761 (elmo-define-obsolete-variable 'elmo-global-flag-list
1762                                'elmo-global-flags)
1763
1764 ;; Obsolete functions.
1765 ;; 2001-12-11: *-dir -> *-directory
1766 (defalias 'elmo-folder-make-temp-dir 'elmo-folder-make-temporary-directory)
1767 (make-obsolete 'elmo-folder-make-temp-dir
1768                'elmo-folder-make-temporary-directory)
1769
1770 (require 'product)
1771 (product-provide (provide 'elmo) (require 'elmo-version))
1772
1773 ;;; elmo.el ends here