elmo/elmo.el

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