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