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