elmo/elmo.el

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