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