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