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 ;; APIs which can be used before opened:
  29
  30 ;; elmo-make-folder
  31 ;; elmo-folder-diff
  32 ;; elmo-folder-open
  33
  34 ;;; Code:
  35 ;;
  36
  37 (require 'product)
  38 (require 'luna)
  39
  40 (require 'elmo-vars)
  41 (require 'elmo-util)
  42 (require 'elmo-msgdb)
  43 (require 'elmo-cache)
  44
  45 (eval-when-compile (require 'cl))
  46
  47 (if (or (featurep 'dbm)
  48         (featurep 'gnudbm)
  49         (featurep 'berkdb)
  50         (featurep 'berkeley-db))
  51     (require 'elmo-database))
  52
  53 (defcustom elmo-message-fetch-threshold 30000
  54   "Fetch threshold."
  55   :type 'integer
  56   :group 'elmo)
  57
  58 (defcustom elmo-message-fetch-confirm t
  59   "Confirm fetching if message size is larger than `elmo-fetch-threshold'.
  60 Otherwise, entire fetching of the message is aborted without confirmation."
  61   :type 'boolean
  62   :group 'elmo)
  63
  64 (defcustom elmo-folder-update-threshold 500
  65   "Update threshold."
  66   :type 'integer
  67   :group 'elmo)
  68
  69 (defcustom elmo-folder-update-confirm t
  70   "Confirm if update number exceeds `elmo-folder-update-threshold'."
  71   :type 'boolean
  72   :group 'elmo)
  73
  74 ;;; internal
  75 (defvar elmo-folder-type-alist nil)
  76 (elmo-define-error 'elmo-error "Error" 'error)
  77 (elmo-define-error 'elmo-open-error "Cannot open" 'elmo-error)
  78 (elmo-define-error 'elmo-authenticate-error "Login failed" 'elmo-open-error)
  79 (elmo-define-error 'elmo-imap4-bye-error "IMAP4 BYE response" 'elmo-open-error)
  80
  81 (defun elmo-define-folder (prefix backend)
  82   "Define a folder.
  83 If a folder name begins with PREFIX, use BACKEND."
  84   (let ((pair (assq prefix elmo-folder-type-alist)))
  85     (if pair
  86         (progn
  87           (setcar pair prefix)
  88           (setcdr pair backend))
  89       (setq elmo-folder-type-alist (cons (cons prefix backend)
  90                                          elmo-folder-type-alist)))))
  91
  92 (defmacro elmo-folder-type (name)
  93   "Get folder type from NAME string."
  94   (` (and (stringp (, name))
  95           (cdr (assoc (string-to-char (, name)) elmo-folder-type-alist)))))
  96
  97 ;;; ELMO folder
  98 ;; A elmo folder provides uniformed (orchestrated) access
  99 ;; to the internet messages.
 100 (eval-and-compile
 101   (luna-define-class elmo-folder () (type   ; folder type symbol.
 102                                      name   ; orignal folder name string.
 103                                      prefix ; prefix for folder name
 104                                      path   ; directory path for msgdb.
 105                                      msgdb  ; msgdb (may be nil).
 106                                      killed-list  ; killed list.
 107                                      persistent   ; non-nil if persistent.
 108                                      message-modified ; message is modified.
 109                                      mark-modified    ; mark is modified.
 110                                      ))
 111   (luna-define-internal-accessors 'elmo-folder))
 112
 113 (luna-define-generic elmo-folder-initialize (folder name)
 114   ;; Initialize a FOLDER structure with NAME."
 115   )
 116
 117 (defmacro elmo-folder-send (folder message &rest args)
 118   "Let FOLDER receive the MESSAGE with ARGS."
 119   (` (luna-send (, folder) (, message) (, folder) (,@ args))))
 120
 121 ;;;###autoload
 122 (defun elmo-make-folder (name &optional non-persistent)
 123   "Make an ELMO folder structure specified by NAME.
 124 If optional argument NON-PERSISTENT is non-nil, folder is treated as
 125  non-persistent."
 126   (let ((type (elmo-folder-type name))
 127         prefix split class folder original)
 128     (setq original (elmo-string name))
 129     (if type
 130         (progn
 131           (setq prefix (substring name 0 1))
 132           (setq name (substring name 1)))
 133       (setq type (intern (car (setq split (split-string name ":")))))
 134       (setq name (substring name (+ 1 (length (car split)))))
 135       (setq prefix (concat (car split) ":")))
 136     (setq class (format "elmo-%s" (symbol-name type)))
 137     (require (intern class))
 138     (setq folder (luna-make-entity (intern (concat class "-folder"))
 139                                    :type   type
 140                                    :prefix prefix
 141                                    :name original
 142                                    :persistent (not non-persistent)))
 143     (save-match-data
 144       (elmo-folder-send folder 'elmo-folder-initialize name))))
 145
 146 (luna-define-generic elmo-folder-open (folder)
 147   "Open and setup (load saved status) FOLDER.")
 148
 149 (luna-define-generic elmo-folder-open-internal (folder)
 150   "Open FOLDER (without loading saved folder status).")
 151
 152 (luna-define-generic elmo-folder-check (folder)
 153   "Check the FOLDER to obtain newest information at the next list operation.")
 154
 155 (luna-define-generic elmo-folder-commit (folder)
 156   "Save current status of FOLDER.")
 157
 158 (luna-define-generic elmo-folder-close (folder)
 159   "Close, save and clearnup FOLDER.")
 160
 161 (luna-define-generic elmo-folder-close-internal (folder)
 162   "Close FOLDER (without saving folder status).")
 163
 164 (luna-define-generic elmo-folder-plugged-p (folder)
 165   "Returns t if FOLDER is plugged.")
 166
 167 (luna-define-generic elmo-folder-set-plugged (folder plugged &optional add)
 168   "Set FOLDER as plugged.")
 169
 170 (luna-define-generic elmo-folder-use-flag-p (folder)
 171   "Returns t if FOLDER treats unread/important flag itself.")
 172
 173 (luna-define-generic elmo-folder-diff (folder &optional numbers)
 174   "Get diff of FOLDER.
 175 If optional NUMBERS is set, it is used as current NUMBERS.
 176 Otherwise, saved status for folder is used for comparison.
 177 Return value is a cons cell of NEWS and MESSAGES.")
 178
 179 (luna-define-generic elmo-folder-status (folder)
 180   "Returns a cons cell of (MAX-NUMBER . MESSAGES) in the FOLDER.")
 181
 182 (defun elmo-folder-list-messages (folder)
 183   "Return a list of message numbers contained in FOLDER."
 184   (let ((list (elmo-folder-list-messages-internal folder))
 185         (killed (elmo-folder-killed-list-internal folder))
 186         numbers)
 187     (setq numbers
 188           (if (listp list)
 189               list
 190             ;; Not available, use current list.
 191             (mapcar
 192              'car
 193              (elmo-msgdb-get-number-alist (elmo-folder-msgdb folder)))))
 194     (elmo-living-messages numbers killed)))
 195
 196 (defun elmo-folder-list-unreads (folder unread-marks)
 197   "Return a list of unread message numbers contained in FOLDER.
 198 UNREAD-MARKS is the unread marks."
 199   (let ((list (elmo-folder-list-unreads-internal folder unread-marks)))
 200     (if (listp list)
 201         list
 202       ;; Not available, use current mark.
 203       (delq nil
 204             (mapcar
 205              (function
 206               (lambda (x)
 207                 (if (member (cadr x) unread-marks)
 208                     (car x))))
 209              (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))))))
 210
 211 (defun elmo-folder-list-importants (folder important-mark)
 212   "Returns a list of important message numbers contained in FOLDER.
 213 IMPORTANT-MARK is the important mark."
 214   (let ((list (elmo-folder-list-importants-internal folder important-mark)))
 215     (if (listp list)
 216         list
 217       ;; Not available, use current mark.
 218       (delq nil
 219             (mapcar
 220              (function
 221               (lambda (x)
 222                 (if (string= (cadr x) important-mark)
 223                     (car x))))
 224              (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))))))
 225
 226 (luna-define-generic elmo-folder-list-messages-internal (folder)
 227   ;; Return a list of message numbers contained in FOLDER.
 228   ;; Return t if the message list is not available.
 229   )
 230
 231 (luna-define-generic elmo-folder-list-unreads-internal (folder unread-marks)
 232   ;; Return a list of unread message numbers contained in FOLDER.
 233   ;; Return t if this feature is not available.
 234   )
 235
 236 (luna-define-generic elmo-folder-list-importants-internal (folder
 237                                                            important-mark)
 238   ;; Return a list of important message numbers contained in FOLDER.
 239   ;; Return t if this feature is not available.
 240   )
 241
 242 (luna-define-generic elmo-folder-list-subfolders (folder &optional one-level)
 243   "Returns a list of subfolders contained in FOLDER.
 244 If optional argument ONE-LEVEL is non-nil, only children of FOLDER is returned.
 245 (a folder which have children is returned as a list)
 246 Otherwise, all descendent folders are returned.")
 247
 248 (luna-define-generic elmo-folder-exists-p (folder)
 249   "Returns non-nil when FOLDER exists.")
 250
 251 (luna-define-generic elmo-folder-creatable-p (folder)
 252   "Returns non-nil when FOLDER is creatable.")
 253
 254 (luna-define-generic elmo-folder-persistent-p (folder)
 255   "Return non-nil when FOLDER is persistent.")
 256
 257 (luna-define-generic elmo-folder-create (folder)
 258   "Create a FOLDER.")
 259
 260 (luna-define-generic elmo-folder-message-appendable-p (folder)
 261   "Returns non-nil when FOLDER is appendable.")
 262
 263 (luna-define-generic elmo-message-deletable-p (folder number)
 264   "Returns non-nil when the message in the FOLDER with NUMBER is deletable.")
 265
 266 (luna-define-generic elmo-folder-delete (folder)
 267   "Delete FOLDER completely.")
 268
 269 (luna-define-generic elmo-folder-rename (folder new-name)
 270   "Rename FOLDER to NEW-NAME (string).")
 271
 272 (luna-define-generic elmo-folder-delete-messages (folder numbers)
 273   "Delete messages.
 274 FOLDER is the ELMO folder structure.
 275 NUMBERS is a list of message numbers to be deleted.")
 276
 277 (luna-define-generic elmo-folder-search (folder condition &optional numbers)
 278   "Search and return list of message numbers.
 279 FOLDER is the ELMO folder structure.
 280 CONDITION is a condition string for searching.
 281 If optional argument NUMBERS is specified and is a list of message numbers,
 282 messages are searched from the list.")
 283
 284 (luna-define-generic elmo-folder-msgdb-create
 285   (folder numbers new-mark already-mark seen-mark important-mark seen-list)
 286   "Create a message database (implemented in each backends).
 287 FOLDER is the ELMO folder structure.
 288 NUMBERS is a list of message numbers to create msgdb.
 289 NEW-MARK, ALREADY-MARK, SEEN-MARK, and IMPORTANT-MARK are mark string for
 290 new message, unread but cached message, read message and important message.
 291 SEEN-LIST is a list of message-id string which should be treated as read.")
 292
 293 (luna-define-generic elmo-folder-unmark-important (folder numbers)
 294   "Un-mark messages as important.
 295 FOLDER is the ELMO folder structure.
 296 NUMBERS is a list of message numbers to be processed.")
 297
 298 (luna-define-generic elmo-folder-mark-as-important (folder numbers)
 299   "Mark messages as important.
 300 FOLDER is the ELMO folder structure.
 301 NUMBERS is a list of message numbers to be processed.")
 302
 303 (luna-define-generic elmo-folder-unmark-read (folder numbers)
 304   "Un-mark messages as read.
 305 FOLDER is the ELMO folder structure.
 306 NUMBERS is a list of message numbers to be processed.")
 307
 308 (luna-define-generic elmo-folder-mark-as-read (folder numbers)
 309   "Mark messages as read.
 310 FOLDER is the ELMO folder structure.
 311 NUMBERS is a list of message numbers to be processed.")
 312
 313 (luna-define-generic elmo-folder-append-buffer (folder unread &optional number)
 314   "Append current buffer as a new message.
 315 FOLDER is the destination folder(ELMO folder structure).
 316 If UNREAD is non-nil, message is appended as unread.
 317 If optional argument NUMBER is specified, the new message number is set
 318 (if possible).")
 319
 320 (luna-define-generic elmo-folder-append-messages (folder
 321                                                   src-folder
 322                                                   numbers
 323                                                   unread-marks
 324                                                   &optional
 325                                                   same-number)
 326   "Append messages from folder.
 327 FOLDER is the ELMO folder structure.
 328 Make sure FOLDER is `message-appendable'.
 329 (Can be checked with `elmo-folder-message-appendable-p').
 330 SRC-FOLDER is the source ELMO folder structure.
 331 NUMBERS is the message numbers to be appended in the SRC-FOLDER.
 332 UNREAD-MARKS is a list of unread mark string.
 333 If second optional argument SAME-NUMBER is specified,
 334 message number is preserved (if possible).")
 335
 336 (luna-define-generic elmo-folder-pack-numbers (folder)
 337   "Pack message numbers of FOLDER.")
 338
 339 (luna-define-generic elmo-folder-update-number (folder)
 340   "Update number of FOLDER.")
 341
 342 (luna-define-generic elmo-folder-diff-async (folder)
 343   "Get diff of FOLDER asynchronously.")
 344
 345 (luna-define-generic elmo-folder-expand-msgdb-path (folder)
 346   "Expand path for FOLDER.")
 347
 348 (luna-define-generic elmo-folder-get-primitive-list (folder)
 349   "Get primitive folder structure list contained in FOLDER.")
 350
 351 (luna-define-generic elmo-folder-contains-type (folder type)
 352   "Returns t if FOLDER contains TYPE.")
 353
 354 (luna-define-generic elmo-folder-local-p (folder)
 355   "Returns t if FOLDER is local.")
 356
 357 (luna-define-generic elmo-folder-message-file-p (folder)
 358   "Returns t if all messages in the FOLDER are files.")
 359
 360 ;;; Message methods.
 361 (luna-define-generic elmo-message-use-cache-p (folder number)
 362   "Returns t if the message in the FOLDER with NUMBER uses cache.")
 363
 364 (luna-define-generic elmo-message-file-name (folder number)
 365   "Return the file name of a message specified by FOLDER and NUMBER.")
 366
 367 ;;; For archive
 368
 369 ;;; Use original file
 370 (luna-define-generic elmo-folder-message-file-number-p (folder)
 371   "Return t if the file name in the FOLDER is the message number.")
 372
 373 (luna-define-generic elmo-folder-message-file-directory (folder)
 374   "Return the directory of the message files of FOLDER.")
 375
 376 ;;; Use temporary file
 377 (luna-define-generic elmo-folder-message-make-temp-file-p (folder)
 378   "Return t if the messages in the FOLDER makes local temporary file.")
 379
 380 (luna-define-generic elmo-folder-message-make-temp-files (folder
 381                                                           numbers
 382                                                           &optional
 383                                                           start-number)
 384   "Make a new temporary files from the messages in the FOLDER with NUMBERS.
 385 If START-NUMBER is specified, temporary files begin from the number.
 386 Otherwise, same number is used for temporary files.
 387 Return newly created temporary directory name which contains temporary files.")
 388
 389 (luna-define-generic elmo-message-file-p (folder number)
 390   "Return t if message in the FOLDER with NUMBER is a file.")
 391
 392 (luna-define-generic elmo-find-fetch-strategy
 393   (folder entity &optional ignore-cache)
 394 ;; Returns the message fetching strategy suitable for the message.
 395 ;; FOLDER is the ELMO folder structure.
 396 ;; ENTITY is the overview entity of the message in the folder.
 397 ;; If optional argument IGNORE-CACHE is non-nil, cache is ignored.
 398 ;; Returned value is a elmo-fetch-strategy object.
 399 ;; If return value is nil, message should not be nil.
 400   )
 401
 402 (defmacro elmo-make-fetch-strategy (entireness
 403                                     &optional
 404                                     use-cache
 405                                     save-cache
 406                                     cache-path)
 407 ;; Make elmo-message-fetching strategy.
 408 ;; ENTIRENESS is 'entire or 'section.
 409 ;; 'entire means fetch message entirely at once.
 410 ;; 'section means fetch message section by section.
 411 ;; If optional USE-CACHE is non-nil, existing cache is used and otherwise,
 412 ;; existing cache is thrown away.
 413 ;; If SAVE-CACHE is non-nil, fetched message is saved.
 414 ;; CACHE-PATH is the cache path to be used as a message cache file.
 415   (` (vector (, entireness)
 416              (, use-cache) (, save-cache) (, cache-path))))
 417
 418 (defmacro elmo-fetch-strategy-entireness (strategy)
 419   ;; Return entireness of STRATEGY.
 420   (` (aref (, strategy) 0)))
 421
 422 (defmacro elmo-fetch-strategy-use-cache (strategy)
 423   ;; Return use-cache of STRATEGY.
 424   (` (aref (, strategy) 1)))
 425
 426 (defmacro elmo-fetch-strategy-save-cache (strategy)
 427   ;; Return save-cache of STRATEGY.
 428   (` (aref (, strategy) 2)))
 429
 430 (defmacro elmo-fetch-strategy-cache-path (strategy)
 431   ;;  Return cache-path of STRATEGY.
 432   (` (aref (, strategy) 3)))
 433
 434 (luna-define-method elmo-find-fetch-strategy
 435   ((folder elmo-folder) entity &optional ignore-cache)
 436   (let (cache-file size message-id number)
 437     (setq size (elmo-msgdb-overview-entity-get-size entity))
 438     (setq message-id (elmo-msgdb-overview-entity-get-id entity))
 439     (setq number (elmo-msgdb-overview-entity-get-number entity))
 440     (setq cache-file (elmo-file-cache-get message-id))
 441     (if (or ignore-cache
 442             (null (elmo-file-cache-status cache-file)))
 443         ;; No cache or ignore-cache.
 444         (if (and (not (elmo-folder-local-p folder))
 445                  elmo-message-fetch-threshold
 446                  (integerp size)
 447                  (>= size elmo-message-fetch-threshold)
 448                  (or (not elmo-message-fetch-confirm)
 449                      (not (prog1 (y-or-n-p
 450                                   (format "Fetch entire message(%dbytes)? "
 451                                           size))
 452                             (message "")))))
 453             ;; Don't fetch message at all.
 454             nil
 455           ;; Don't use existing cache and fetch entire message at once.
 456           (elmo-make-fetch-strategy
 457            'entire nil
 458            (elmo-message-use-cache-p folder number)
 459            (elmo-file-cache-path cache-file)))
 460       ;; Cache exists.
 461       (if (not ignore-cache)
 462           (elmo-make-fetch-strategy
 463            'entire
 464            ;; ...But ignore current section cache and re-fetch
 465            ;; if section cache.
 466            (not (eq (elmo-file-cache-status cache-file) 'section))
 467            ;; Save cache.
 468            (elmo-message-use-cache-p folder number)
 469            (elmo-file-cache-path cache-file))))))
 470
 471 (luna-define-method elmo-folder-list-messages-internal
 472   ((folder elmo-folder))
 473   t)
 474
 475 (luna-define-method elmo-folder-list-unreads-internal
 476   ((folder elmo-folder) unread-marks)
 477   t)
 478
 479 (luna-define-method elmo-folder-list-importants-internal
 480   ((folder elmo-folder) important-mark)
 481   t)
 482
 483 (defun elmo-message-encache (folder number)
 484   (elmo-message-fetch
 485    folder number
 486    (elmo-make-fetch-strategy 'entire
 487                              nil ;use-cache
 488                              t   ;save-cache
 489                              (elmo-file-cache-get-path
 490                               (elmo-message-field
 491                                folder number 'message-id)))))
 492
 493 (luna-define-generic elmo-message-fetch (folder number strategy
 494                                                 &optional
 495                                                 section
 496                                                 outbuf
 497                                                 unread)
 498   "Fetch a message and return as a string.
 499 FOLDER is the ELMO folder structure.
 500 NUMBER is the number of the message in the FOLDER.
 501 STRATEGY is the message fetching strategy.
 502 If optional argument SECTION is specified, only the SECTION of the message
 503 is fetched (if possible).
 504 If second optional argument OUTBUF is specified, fetched message is
 505 inserted to the buffer and returns t if fetch was ended successfully.
 506 If third optional argument UNREAD is non-nil, message is not marked as read.
 507 Returns non-nil if fetching was succeed.")
 508
 509 (luna-define-generic elmo-message-folder (folder number)
 510   "Get primitive folder of the message.")
 511
 512 (luna-define-generic elmo-folder-append-msgdb (folder append-msgdb)
 513   "Append  APPEND-MSGDB to the current msgdb of the folder.")
 514
 515 (luna-define-method elmo-folder-open ((folder elmo-folder))
 516   (elmo-generic-folder-open folder))
 517
 518 (defun elmo-generic-folder-open (folder)
 519   (elmo-folder-set-msgdb-internal folder (elmo-msgdb-load folder))
 520   (elmo-folder-set-killed-list-internal
 521    folder
 522    (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder)))
 523   (elmo-folder-open-internal folder))
 524
 525 (luna-define-method elmo-folder-open-internal ((folder elmo-folder))
 526   nil ; default is do nothing.
 527   )
 528
 529 (luna-define-method elmo-folder-check ((folder elmo-folder))
 530   nil) ; default is noop.
 531
 532 (luna-define-method elmo-folder-commit ((folder elmo-folder))
 533   (elmo-generic-folder-commit folder))
 534
 535 (defun elmo-generic-folder-commit (folder)
 536   (when (elmo-folder-persistent-p folder)
 537     (when (elmo-folder-message-modified-internal folder)
 538       (elmo-msgdb-overview-save
 539        (elmo-folder-msgdb-path folder)
 540        (elmo-msgdb-get-overview (elmo-folder-msgdb-internal folder)))
 541       (elmo-msgdb-number-save
 542        (elmo-folder-msgdb-path folder)
 543        (elmo-msgdb-get-number-alist (elmo-folder-msgdb-internal folder)))
 544       (elmo-folder-set-info-max-by-numdb
 545        folder
 546        (elmo-msgdb-get-number-alist
 547         (elmo-folder-msgdb-internal folder)))
 548       (elmo-folder-set-message-modified-internal folder nil)
 549       (elmo-msgdb-killed-list-save
 550        (elmo-folder-msgdb-path folder)
 551        (elmo-folder-killed-list-internal folder)))
 552     (when (elmo-folder-mark-modified-internal folder)
 553       (elmo-msgdb-mark-save
 554        (elmo-folder-msgdb-path folder)
 555        (elmo-msgdb-get-mark-alist (elmo-folder-msgdb-internal folder)))
 556       (elmo-folder-set-mark-modified-internal folder nil))))
 557
 558 (luna-define-method elmo-folder-close-internal ((folder elmo-folder))
 559   ;; do nothing.
 560   )
 561
 562 (luna-define-method elmo-folder-close ((folder elmo-folder))
 563   (elmo-generic-folder-close folder)
 564   (elmo-folder-close-internal folder))
 565
 566 (defun elmo-generic-folder-close (folder)
 567   (elmo-folder-commit folder)
 568   (elmo-folder-set-msgdb-internal folder nil)
 569   (elmo-folder-set-killed-list-internal folder nil))
 570
 571 (luna-define-method elmo-folder-plugged-p ((folder elmo-folder))
 572   t) ; default is plugged.
 573
 574 (luna-define-method elmo-folder-set-plugged ((folder elmo-folder) plugged
 575                                              &optional add)
 576   nil) ; default is do nothing.
 577
 578 (luna-define-method elmo-folder-use-flag-p ((folder elmo-folder))
 579   nil) ; default is no flag.
 580
 581 (luna-define-method elmo-folder-persistent-p ((folder elmo-folder))
 582   (elmo-folder-persistent-internal folder))
 583
 584 (luna-define-method elmo-folder-creatable-p ((folder elmo-folder))
 585   t) ; default is creatable.
 586
 587 (luna-define-method elmo-folder-writable-p ((folder elmo-folder))
 588   t) ; default is writable.
 589
 590 (luna-define-method elmo-folder-rename ((folder elmo-folder) new-name)
 591   (let* ((new-folder (elmo-make-folder new-name)))
 592     (unless (eq (elmo-folder-type-internal folder)
 593                 (elmo-folder-type-internal new-folder))
 594       (error "Not same folder type"))
 595     (if (or (file-exists-p (elmo-folder-msgdb-path new-folder))
 596             (elmo-folder-exists-p new-folder))
 597         (error "Already exists folder: %s" new-name))
 598     (elmo-folder-send folder 'elmo-folder-rename-internal new-folder)
 599     (elmo-msgdb-rename-path folder new-folder)))
 600
 601 (luna-define-method elmo-folder-pack-numbers ((folder elmo-folder))
 602   nil) ; default is noop.
 603
 604 (luna-define-method elmo-folder-update-number ((folder elmo-folder))
 605   nil) ; default is noop.
 606
 607 (luna-define-method elmo-folder-message-file-p ((folder elmo-folder))
 608   nil) ; default is not file.
 609
 610 (luna-define-method elmo-folder-message-file-number-p ((folder elmo-folder))
 611   nil) ; default is not number.
 612
 613 (luna-define-method elmo-folder-message-make-temp-file-p ((folder elmo-folder))
 614   nil) ; default is not make temp file.
 615
 616 (luna-define-method elmo-message-file-name ((folder elmo-folder)
 617                                                    number)
 618   nil) ; default is no name.
 619
 620 (luna-define-method elmo-folder-local-p ((folder elmo-folder))
 621   t)   ; default is local.
 622
 623 ;;; Folder info
 624 ;; Folder info is a message number information cache (hashtable)
 625 (defsubst elmo-folder-get-info (folder &optional hashtb)
 626   "Return FOLDER info from HASHTB (default is `elmo-folder-info-hashtb')."
 627   (elmo-get-hash-val (elmo-folder-name-internal folder)
 628                      (or hashtb elmo-folder-info-hashtb)))
 629
 630 (defun elmo-folder-set-info-hashtb (folder max numbers &optional new unread)
 631   "Set FOLDER info (means MAX, NUMBERS, NEW and UNREAD)."
 632   (let ((info (elmo-folder-get-info folder)))
 633     (when info
 634       (or new     (setq new     (nth 0 info)))
 635       (or unread  (setq unread  (nth 1 info)))
 636       (or numbers (setq numbers (nth 2 info)))
 637       (or max     (setq max     (nth 3 info))))
 638     (elmo-set-hash-val (elmo-folder-name-internal folder)
 639                        (list new unread numbers max)
 640                        elmo-folder-info-hashtb)))
 641
 642 (defun elmo-folder-set-info-max-by-numdb (folder msgdb-number)
 643   "Set FOLDER info by MSGDB-NUMBER in msgdb."
 644   (let ((num-db (sort (mapcar 'car msgdb-number) '<)))
 645     (elmo-folder-set-info-hashtb
 646      folder
 647      (or (nth (max 0 (1- (length num-db))) num-db) 0)
 648      nil ;;(length num-db)
 649      )))
 650
 651 (defun elmo-folder-get-info-max (folder)
 652   "Return max number of FODLER from folder info."
 653   (nth 3 (elmo-folder-get-info folder)))
 654
 655 (defun elmo-folder-get-info-length (folder)
 656   "Return length of FODLER from folder info."
 657   (nth 2 (elmo-folder-get-info folder)))
 658
 659 (defun elmo-folder-get-info-unread (folder)
 660   "Return unread of FODLER from folder info."
 661   (nth 1 (elmo-folder-get-info folder)))
 662
 663 (defun elmo-folder-info-make-hashtb (info-alist hashtb)
 664   "Setup folder info hashtable by INFO-ALIST on HASHTB."
 665   (let* ((hashtb (or hashtb
 666                      (elmo-make-hash (length info-alist)))))
 667     (mapcar
 668      (lambda (x)
 669        (let ((info (cadr x)))
 670          (and (intern-soft (car x) hashtb)
 671               (elmo-set-hash-val (car x)
 672                                  (list (nth 2 info)   ;; new
 673                                        (nth 3 info)   ;; unread
 674                                        (nth 1 info)   ;; length
 675                                        (nth 0 info))  ;; max
 676                                  hashtb))))
 677      info-alist)
 678     (setq elmo-folder-info-hashtb hashtb)))
 679
 680 (defsubst elmo-strict-folder-diff (folder)
 681   "Return folder diff information strictly from FOLDER."
 682   (let* ((dir (elmo-folder-msgdb-path folder))
 683          (nalist (or (elmo-folder-msgdb-internal folder)
 684                      (elmo-msgdb-number-load dir)))
 685          (in-db (sort (mapcar 'car nalist) '<))
 686          (in-folder  (elmo-folder-list-messages folder))
 687          append-list delete-list diff)
 688     (cons (if (equal in-folder in-db)
 689               0
 690             (setq diff (elmo-list-diff
 691                         in-folder in-db
 692                         nil
 693                         ))
 694             (setq append-list (car diff))
 695             (setq delete-list (cadr diff))
 696             (if append-list
 697                 (length append-list)
 698               (if delete-list
 699                   (- 0 (length delete-list))
 700                 0)))
 701           (length in-folder))))
 702
 703 (luna-define-method elmo-folder-diff ((folder elmo-folder)
 704                                       &optional numbers)
 705   (elmo-generic-folder-diff folder numbers))
 706
 707 (defun elmo-generic-folder-diff (folder numbers)
 708   (if (elmo-string-match-member (elmo-folder-name-internal folder)
 709                                 elmo-strict-diff-folder-list)
 710       (elmo-strict-folder-diff folder)
 711     (let ((cached-in-db-max (elmo-folder-get-info-max folder))
 712           (in-folder (elmo-folder-status folder))
 713           (in-db t)
 714           unsync messages
 715           in-db-max)
 716       (if numbers
 717           (setq in-db-max (or (nth (max 0 (1- (length numbers))) numbers)
 718                               0))
 719         (if (not cached-in-db-max)
 720             (let ((number-list (mapcar 'car
 721                                        (elmo-msgdb-number-load
 722                                         (elmo-folder-msgdb-path folder)))))
 723               ;; No info-cache.
 724               (setq in-db (sort number-list '<))
 725               (setq in-db-max (or (nth (max 0 (1- (length in-db))) in-db)
 726                                   0))
 727               (elmo-folder-set-info-hashtb folder in-db-max nil))
 728           (setq in-db-max cached-in-db-max)))
 729       (setq unsync (if (and in-db
 730                             (car in-folder))
 731                        (- (car in-folder) in-db-max)
 732                      (if (and in-folder
 733                               (null in-db))
 734                          (cdr in-folder)
 735                        (if (null (car in-folder))
 736                            nil))))
 737       (setq messages (cdr in-folder))
 738       (if (and unsync messages (> unsync messages))
 739           (setq unsync messages))
 740       (cons (or unsync 0) (or messages 0)))))
 741
 742 (defvar elmo-folder-diff-async-callback nil)
 743 (defvar elmo-folder-diff-async-callback-data nil)
 744
 745 (luna-define-method elmo-folder-diff-async ((folder elmo-folder))
 746   (and elmo-folder-diff-async-callback
 747        (funcall elmo-folder-diff-async-callback
 748                 folder
 749                 (elmo-folder-diff folder))))
 750
 751 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-folder))
 752   (list folder))
 753
 754 (luna-define-method elmo-folder-contains-type ((folder elmo-folder) type)
 755   (eq (elmo-folder-type-internal folder) type))
 756
 757 (luna-define-method elmo-folder-append-messages ((folder elmo-folder)
 758                                                  src-folder
 759                                                  numbers
 760                                                  unread-marks
 761                                                  &optional
 762                                                  same-number)
 763   (elmo-generic-folder-append-messages folder src-folder numbers
 764                                        unread-marks same-number))
 765
 766 (defun elmo-generic-folder-append-messages (folder src-folder numbers
 767                                                    unread-marks same-number)
 768   (let (unseen seen-list succeed-numbers failure)
 769     (with-temp-buffer
 770       (while numbers
 771         (setq failure nil)
 772         (condition-case nil
 773             (progn
 774               (elmo-message-fetch src-folder (car numbers)
 775                                   (elmo-make-fetch-strategy
 776                                    'entire)
 777                                   nil (current-buffer)
 778                                   'unread)
 779               (unless (eq (buffer-size) 0)
 780                 (elmo-folder-append-buffer
 781                  folder
 782                  (setq unseen (member (elmo-message-mark
 783                                        src-folder (car numbers))
 784                                       unread-marks))
 785                  (if same-number (car numbers)))))
 786           (error (setq failure t)))
 787         ;; FETCH & APPEND finished
 788         (unless failure
 789           (if unseen (setq seen-list (cons
 790                                       (elmo-message-field
 791                                        src-folder (car numbers)
 792                                        'message-id)
 793                                       seen-list)))
 794           (setq succeed-numbers (cons (car numbers) succeed-numbers)))
 795         (setq numbers (cdr numbers)))
 796       (if (and seen-list (elmo-folder-persistent-p folder))
 797           (elmo-msgdb-seen-save (elmo-folder-msgdb-path folder)
 798                                 (nconc (elmo-msgdb-seen-load
 799                                         (elmo-folder-msgdb-path folder))
 800                                        seen-list)))
 801       succeed-numbers)))
 802
 803 ;; Arguments should be reduced.
 804 (defun elmo-folder-move-messages (src-folder msgs dst-folder
 805                                              &optional msgdb all done
 806                                              no-delete-info
 807                                              no-delete
 808                                              same-number
 809                                              unread-marks
 810                                              save-unread)
 811   (save-excursion
 812     (let* ((messages msgs)
 813            (len (length msgs))
 814            (all-msg-num (or all len))
 815            (done-msg-num (or done 0))
 816            (progress-message (if no-delete
 817                                  "Copying messages..."
 818                                "Moving messages..."))
 819            succeeds i result)
 820       (unless (eq dst-folder 'null)
 821         ;; src is already opened.
 822         (when messages
 823           (elmo-folder-open-internal dst-folder)
 824           (unless (setq succeeds (elmo-folder-append-messages dst-folder
 825                                                               src-folder
 826                                                               messages
 827                                                               unread-marks
 828                                                               same-number))
 829             (error "move: append message to %s failed"
 830                    (elmo-folder-name-internal dst-folder)))
 831           (elmo-folder-close dst-folder))
 832         (when (and (elmo-folder-persistent-p dst-folder)
 833                    save-unread)
 834           ;; Save to seen list.
 835           (let* ((dir (elmo-folder-msgdb-path dst-folder))
 836                  (seen-list (elmo-msgdb-seen-load dir)))
 837             (setq seen-list
 838                   (elmo-msgdb-add-msgs-to-seen-list
 839                    msgs (elmo-folder-msgdb-internal src-folder)
 840                    unread-marks seen-list))
 841             (elmo-msgdb-seen-save dir seen-list))))
 842       (when (and done
 843                  (> all-msg-num elmo-display-progress-threshold))
 844         (elmo-display-progress
 845          'elmo-folder-move-messages progress-message
 846          (/ (* done-msg-num 100) all-msg-num)))
 847       (if (and (not no-delete) succeeds)
 848           (progn
 849             (if (not no-delete-info)
 850                 (message "Cleaning up src folder..."))
 851             (if (and (elmo-folder-delete-messages src-folder succeeds)
 852                      (elmo-msgdb-delete-msgs src-folder succeeds))
 853                 (setq result t)
 854               (message "move: delete messages from %s failed."
 855                        (elmo-folder-name-internal src-folder))
 856               (setq result nil))
 857             (if (and result
 858                      (not no-delete-info))
 859                 (message "Cleaning up src folder...done"))
 860             result)
 861         (if no-delete
 862             (progn
 863               (message "Copying messages...done")
 864               t)
 865           (if (eq len 0)
 866               (message "No message was moved.")
 867             (message "Moving messages failed.")
 868             nil ; failure
 869             ))))))
 870
 871 (defun elmo-folder-msgdb-path (folder)
 872   "Return the msgdb path for FOLDER."
 873   (or (elmo-folder-path-internal folder)
 874       (elmo-folder-set-path-internal
 875        folder
 876        (elmo-folder-expand-msgdb-path folder))))
 877
 878 (defun elmo-folder-msgdb (folder)
 879   "Return the msgdb of FOLDER (on-demand loading)."
 880   (or (elmo-folder-msgdb-internal folder)
 881       (elmo-msgdb-load folder)))
 882
 883 (defun elmo-message-mark (folder number)
 884   "Get mark of the message.
 885 FOLDER is the ELMO folder structure.
 886 NUMBER is a number of the message."
 887   (cdr (assq number (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))))
 888
 889 (defun elmo-message-field (folder number field)
 890   "Get message field value in the msgdb.
 891 FOLDER is the ELMO folder structure.
 892 NUMBER is a number of the message.
 893 FIELD is a symbol of the field."
 894   (case field
 895     (message-id (elmo-msgdb-overview-entity-get-id
 896                  (elmo-msgdb-overview-get-entity
 897                   number (elmo-folder-msgdb folder))))
 898     (subject (elmo-msgdb-overview-entity-get-subject
 899               (elmo-msgdb-overview-get-entity
 900                number (elmo-folder-msgdb folder))))
 901     (size (elmo-msgdb-overview-entity-get-size
 902            (elmo-msgdb-overview-get-entity
 903             number (elmo-folder-msgdb folder))))
 904     (date (elmo-msgdb-overview-entity-get-date
 905            (elmo-msgdb-overview-get-entity
 906             number (elmo-folder-msgdb folder))))
 907     (to (elmo-msgdb-overview-entity-get-to
 908          (elmo-msgdb-overview-get-entity
 909           number (elmo-folder-msgdb folder))))
 910     (cc (elmo-msgdb-overview-entity-get-cc
 911          (elmo-msgdb-overview-get-entity
 912           number (elmo-folder-msgdb folder))))))
 913
 914 (defun elmo-message-set-mark (folder number mark)
 915   "Set mark for the message in the FOLDER with NUMBER as MARK."
 916   (elmo-msgdb-set-mark-alist
 917    (elmo-folder-msgdb-internal folder)
 918    (elmo-msgdb-mark-set
 919     (elmo-msgdb-get-mark-alist (elmo-folder-msgdb-internal folder))
 920     number mark)))
 921
 922 (luna-define-method elmo-message-use-cache-p ((folder elmo-folder) number)
 923   nil) ; default is not use cache.
 924
 925 (luna-define-method elmo-message-folder ((folder elmo-folder) number)
 926   folder) ; default is folder
 927
 928 (luna-define-method elmo-folder-unmark-important ((folder elmo-folder) numbers)
 929   t)
 930
 931 (luna-define-method elmo-folder-mark-as-important ((folder elmo-folder)
 932                                                    numbers)
 933   t)
 934
 935 (luna-define-method elmo-folder-unmark-read ((folder elmo-folder) numbers)
 936   t)
 937
 938 (luna-define-method elmo-folder-mark-as-read ((folder elmo-folder) numbers)
 939   t)
 940
 941 (defun elmo-generic-folder-append-msgdb (folder append-msgdb)
 942   (let* ((number-alist (elmo-msgdb-get-number-alist append-msgdb))
 943          (all-alist (copy-sequence (append
 944                                     (elmo-msgdb-get-number-alist
 945                                      (elmo-folder-msgdb-internal folder))
 946                                     number-alist)))
 947          (cur number-alist)
 948          pair
 949          to-be-deleted
 950          mark-alist)
 951     (while cur
 952       (setq all-alist (delq (car cur) all-alist))
 953       ;; same message id exists.
 954       (if (setq pair (rassoc (cdr (car cur)) all-alist))
 955           (setq to-be-deleted (nconc to-be-deleted (list (car pair)))))
 956       (setq cur (cdr cur)))
 957     (setq mark-alist (elmo-delete-if
 958                       (function
 959                        (lambda (x)
 960                          (memq (car x) to-be-deleted)))
 961                       (elmo-msgdb-get-mark-alist append-msgdb)))
 962     (elmo-msgdb-set-mark-alist append-msgdb mark-alist)
 963     (elmo-folder-set-msgdb-internal folder
 964                                     (elmo-msgdb-append
 965                                      (elmo-folder-msgdb-internal folder)
 966                                      append-msgdb t))
 967     (length to-be-deleted)))
 968
 969 (luna-define-method elmo-folder-append-msgdb ((folder elmo-folder)
 970                                               append-msgdb)
 971   (elmo-generic-folder-append-msgdb folder append-msgdb))
 972
 973 (defun elmo-folder-confirm-appends (appends)
 974   (let ((len (length appends))
 975         in)
 976     (if (and (> len elmo-folder-update-threshold)
 977              elmo-folder-update-confirm)
 978         (if (y-or-n-p (format "Too many messages(%d).  Continue? " len))
 979             appends
 980           (setq in elmo-folder-update-threshold)
 981           (catch 'end
 982             (while t
 983               (setq in (read-from-minibuffer "Update number: "
 984                                              (int-to-string in))
 985                     in (string-to-int in))
 986               (if (< len in)
 987                   (throw 'end len))
 988               (if (y-or-n-p (format "%d messages are disappeared.  OK? "
 989                                     (max (- len in) 0)))
 990                   (throw 'end in))))
 991           (nthcdr (max (- len in) 0) appends))
 992       (if (and (> len elmo-folder-update-threshold)
 993                (not elmo-folder-update-confirm))
 994           (nthcdr (max (- len elmo-folder-update-threshold) 0) appends)
 995         appends))))
 996
 997 (defun elmo-folder-synchronize (folder
 998                                 new-mark             ;"N"
 999                                 unread-uncached-mark ;"U"
1000                                 unread-cached-mark   ;"!"
1001                                 read-uncached-mark   ;"u"
1002                                 important-mark       ;"$"
1003                                 &optional ignore-msgdb)
1004   "Synchronize the folder data to the newest status.
1005 FOLDER is the ELMO folder structure.
1006 NEW-MARK, UNREAD-CACHED-MARK, READ-UNCACHED-MARK, and IMPORTANT-MARK
1007 are mark strings for new messages, unread but cached messages,
1008 read but not cached messages, and important messages.
1009 If optional IGNORE-MSGDB is non-nil, current msgdb is thrown away except
1010 read mark status.
1011
1012 Return a list of
1013 \(NEW-MSGDB DELETE-LIST CROSSED\)
1014 NEW-MSGDB is the newly appended msgdb.
1015 DELETE-LIST is a list of deleted message number.
1016 CROSSED is cross-posted message number."
1017   (let ((killed-list (elmo-folder-killed-list-internal folder))
1018         (before-append t)
1019         number-alist mark-alist
1020         old-msgdb diff diff-2 delete-list new-list new-msgdb mark
1021         seen-list crossed after-append)
1022     (setq old-msgdb (elmo-folder-msgdb-internal folder))
1023     ;; Load seen-list.
1024     (setq seen-list (elmo-msgdb-seen-load (elmo-folder-msgdb-path folder)))
1025     (setq number-alist (elmo-msgdb-get-number-alist
1026                         (elmo-folder-msgdb-internal folder)))
1027     (setq mark-alist (elmo-msgdb-get-mark-alist
1028                       (elmo-folder-msgdb-internal folder)))
1029     (if ignore-msgdb
1030         (progn
1031           (setq seen-list (nconc
1032                            (elmo-msgdb-mark-alist-to-seen-list
1033                             number-alist mark-alist
1034                             (concat important-mark read-uncached-mark))
1035                            seen-list))
1036           ;; Make killed list as nil.
1037           (elmo-folder-set-killed-list-internal folder nil)
1038           (elmo-folder-set-msgdb-internal folder
1039                                           (elmo-msgdb-clear))))
1040     (elmo-folder-check folder)
1041     (condition-case nil
1042         (progn
1043           (message "Checking folder diff...")
1044           ;; TODO: killed list is loaded in elmo-folder-open and
1045           ;; list-messages use internal killed-list-folder.
1046           (setq diff (elmo-list-diff (elmo-folder-list-messages folder)
1047                                      (unless ignore-msgdb
1048                                        (sort (mapcar
1049                                               'car
1050                                               number-alist)
1051                                              '<))))
1052           (message "Checking folder diff...done")
1053           (setq new-list (elmo-folder-confirm-appends (car diff)))
1054           ;; Set killed list.
1055           (when (and (not (eq (length (car diff))
1056                               (length new-list)))
1057                      (setq diff-2 (elmo-list-diff (car diff) new-list)))
1058             (elmo-msgdb-append-to-killed-list folder (car diff-2)))
1059           ;; Don't delete important marked messages.
1060           (setq delete-list
1061                 (elmo-delete-if
1062                  (lambda (x)
1063                    (and (setq mark (cadr (assq x mark-alist)))
1064                         (string= mark important-mark)))
1065                  ;; delete message list
1066                  (cadr diff)))
1067           (if (or (equal diff '(nil nil))
1068                   (equal diff '(nil))
1069                   (and (eq (length (car diff)) 0)
1070                        (eq (length (cadr diff)) 0)))
1071               (progn
1072                 ;; NNTP:
1073                 (elmo-folder-update-number folder)
1074                 nil ; no update
1075                 )
1076             (if delete-list (elmo-msgdb-delete-msgs folder delete-list))
1077             (when new-list
1078               (setq new-msgdb (elmo-folder-msgdb-create
1079                                folder
1080                                new-list
1081                                new-mark unread-cached-mark
1082                                read-uncached-mark important-mark
1083                                seen-list))
1084               (elmo-msgdb-change-mark (elmo-folder-msgdb-internal folder)
1085                                       new-mark unread-uncached-mark)
1086               ;; Clear seen-list.
1087               (if (elmo-folder-persistent-p folder)
1088                   (setq seen-list (elmo-msgdb-seen-save
1089                                    (elmo-folder-msgdb-path folder) nil)))
1090               (setq before-append nil)
1091               (setq crossed (elmo-folder-append-msgdb folder new-msgdb))
1092               (elmo-folder-set-message-modified-internal folder t)
1093               (elmo-folder-set-mark-modified-internal folder t))
1094             ;; return value.
1095             (list new-msgdb delete-list crossed)))
1096       (quit
1097        ;; Resume to the original status.
1098        (if before-append
1099            (elmo-folder-set-msgdb-internal folder old-msgdb))
1100        (elmo-folder-set-killed-list-internal folder killed-list)
1101        nil))))
1102
1103 (defun elmo-folder-messages (folder)
1104   "Return number of messages in the FOLDER."
1105   (length
1106    (elmo-msgdb-get-number-alist
1107     (elmo-folder-msgdb-internal folder))))
1108
1109 ;;;
1110 (defun elmo-msgdb-search (folder condition msgdb)
1111   "Search messages which satisfy CONDITION from FOLDER with MSGDB."
1112   (let* ((condition (car (elmo-parse-search-condition condition)))
1113          (overview (elmo-msgdb-get-overview msgdb))
1114          (number-alist (elmo-msgdb-get-number-alist msgdb))
1115          (number-list (mapcar 'car number-alist))
1116          (length (length overview))
1117          (i 0)
1118          result)
1119     (if (elmo-condition-find-key condition "body")
1120         (elmo-folder-search folder condition number-list)
1121       (while overview
1122         (if (elmo-msgdb-search-internal condition (car overview)
1123                                         number-list)
1124             (setq result
1125                   (cons
1126                    (elmo-msgdb-overview-entity-get-number (car overview))
1127                    result)))
1128         (setq i (1+ i))
1129         (elmo-display-progress
1130          'elmo-msgdb-search "Searching..." (/ (* i 100) length))
1131         (setq overview (cdr overview)))
1132       (nreverse result))))
1133
1134 (defun elmo-msgdb-load (folder)
1135   (message "Loading msgdb for %s..." (elmo-folder-name-internal folder))
1136   (let* ((path (elmo-folder-msgdb-path folder))
1137          (overview (elmo-msgdb-overview-load path))
1138          (msgdb (list overview
1139                       (elmo-msgdb-number-load path)
1140                       (elmo-msgdb-mark-load path)
1141                       (elmo-msgdb-make-overview-hashtb overview))))
1142     (message "Loading msgdb for %s...done" (elmo-folder-name-internal folder))
1143     (elmo-folder-set-info-max-by-numdb folder
1144                                        (elmo-msgdb-get-number-alist msgdb))
1145     msgdb))
1146
1147 (defun elmo-msgdb-delete-path (folder)
1148   (let ((path (elmo-folder-msgdb-path folder)))
1149     (if (file-directory-p path)
1150         (elmo-delete-directory path t))))
1151
1152 (defun elmo-msgdb-rename-path (old-folder new-folder)
1153   (let* ((old (directory-file-name (elmo-folder-msgdb-path old-folder)))
1154          (new (directory-file-name (elmo-folder-msgdb-path new-folder)))
1155          (new-dir (directory-file-name (file-name-directory new))))
1156     (if (not (file-directory-p old))
1157         ()
1158       (if (file-exists-p new)
1159           (error "Already exists directory: %s" new)
1160         (if (not (file-exists-p new-dir))
1161             (elmo-make-directory new-dir))
1162         (rename-file old new)))))
1163
1164 (defun elmo-crosspost-message-set (message-id folders &optional type)
1165   (if (assoc message-id elmo-crosspost-message-alist)
1166       (setcdr (assoc message-id elmo-crosspost-message-alist)
1167               (list folders type))
1168     (setq elmo-crosspost-message-alist
1169           (nconc elmo-crosspost-message-alist
1170                  (list (list message-id folders type))))))
1171
1172 (defun elmo-crosspost-message-delete (message-id folders)
1173   (let* ((id-fld (assoc message-id elmo-crosspost-message-alist))
1174          (folder-list (nth 1 id-fld)))
1175     (when id-fld
1176       (if (setq folder-list (elmo-list-delete folders folder-list))
1177           (setcar (cdr id-fld) folder-list)
1178         (setq elmo-crosspost-message-alist
1179               (delete id-fld elmo-crosspost-message-alist))))))
1180
1181 (defun elmo-folder-make-temp-dir (folder)
1182   ;; Make a temporary directory for FOLDER.
1183   (let ((temp-dir (make-temp-name
1184                    (concat
1185                     (file-name-as-directory (elmo-folder-msgdb-path folder))
1186                     "elmo"))))
1187     (elmo-make-directory temp-dir)
1188     temp-dir))
1189
1190 (defun elmo-quit ()
1191   "Quit and cleanup ELMO."
1192   ;; Not implemented yet.
1193   (let ((types elmo-folder-type-alist)
1194         class)
1195     (while types
1196       (setq class
1197             (luna-find-class
1198              (intern (format "elmo-%s-folder" (symbol-name (cdr (car types)))))))
1199       ;; Call all folder's `elmo-quit' method.
1200       (if class
1201           (dolist (func (luna-class-find-functions class 'elmo-quit))
1202             (funcall func nil)))
1203       (setq types (cdr types)))))
1204
1205
1206 ;;; Define folders.
1207 (elmo-define-folder ?% 'imap4)
1208 (elmo-define-folder ?-  'nntp)
1209 (elmo-define-folder ?\+ 'localdir)
1210 (elmo-define-folder ?\* 'multi)
1211 (elmo-define-folder ?\/ 'filter)
1212 (elmo-define-folder ?\$ 'archive)
1213 (elmo-define-folder ?&  'pop3)
1214 (elmo-define-folder ?=  'localnews)
1215 (elmo-define-folder ?|  'pipe)
1216 (elmo-define-folder ?.  'maildir)
1217 (elmo-define-folder ?'  'internal)
1218 (elmo-define-folder ?[  'nmz)
1219
1220 (product-provide (provide 'elmo) (require 'elmo-version))
1221
1222 ;; elmo.el ends here.
1223 (provide 'elmo)
1224
1225 ;;; elmo.el ends here