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