elmo/elmo.el

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