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