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-method elmo-folder-open ((folder elmo-folder)
 604                                       &optional load-msgdb)
 605   (elmo-generic-folder-open folder load-msgdb))
 606
 607 (defun elmo-generic-folder-open (folder load-msgdb)
 608   (let ((inhibit-quit t))
 609     (if load-msgdb
 610         (elmo-folder-set-msgdb-internal folder (elmo-msgdb-load folder)))
 611     (elmo-folder-set-killed-list-internal
 612      folder
 613      (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder))))
 614   (elmo-folder-open-internal folder))
 615
 616 (luna-define-method elmo-folder-open-internal ((folder elmo-folder))
 617   nil ; default is do nothing.
 618   )
 619
 620 (luna-define-method elmo-folder-check ((folder elmo-folder))
 621   nil) ; default is noop.
 622
 623 (luna-define-method elmo-folder-commit ((folder elmo-folder))
 624   (elmo-generic-folder-commit folder))
 625
 626 (defun elmo-generic-folder-commit (folder)
 627   (when (elmo-folder-persistent-p folder)
 628     (when (elmo-folder-message-modified-internal folder)
 629       (elmo-msgdb-overview-save
 630        (elmo-folder-msgdb-path folder)
 631        (elmo-msgdb-get-overview (elmo-folder-msgdb folder)))
 632       (elmo-msgdb-number-save
 633        (elmo-folder-msgdb-path folder)
 634        (elmo-msgdb-get-number-alist (elmo-folder-msgdb folder)))
 635       (elmo-folder-set-info-max-by-numdb
 636        folder
 637        (elmo-msgdb-get-number-alist
 638         (elmo-folder-msgdb folder)))
 639       (elmo-folder-set-message-modified-internal folder nil)
 640       (elmo-msgdb-killed-list-save
 641        (elmo-folder-msgdb-path folder)
 642        (elmo-folder-killed-list-internal folder)))
 643     (when (elmo-folder-mark-modified-internal folder)
 644       (elmo-msgdb-mark-save
 645        (elmo-folder-msgdb-path folder)
 646        (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))
 647       (elmo-folder-set-mark-modified-internal folder nil))))
 648
 649 (luna-define-method elmo-folder-close-internal ((folder elmo-folder))
 650   ;; do nothing.
 651   )
 652
 653 (luna-define-method elmo-folder-close ((folder elmo-folder))
 654   (elmo-generic-folder-close folder)
 655   (elmo-folder-close-internal folder))
 656
 657 (defun elmo-generic-folder-close (folder)
 658   (elmo-folder-commit folder)
 659   (elmo-folder-set-msgdb-internal folder nil)
 660   (elmo-folder-set-killed-list-internal folder nil))
 661
 662 (luna-define-method elmo-folder-plugged-p ((folder elmo-folder))
 663   t) ; default is plugged.
 664
 665 (luna-define-method elmo-folder-set-plugged ((folder elmo-folder) plugged
 666                                              &optional add)
 667   nil) ; default is do nothing.
 668
 669 (luna-define-method elmo-folder-use-flag-p ((folder elmo-folder))
 670   nil) ; default is no flag.
 671
 672 (luna-define-method elmo-folder-persistent-p ((folder elmo-folder))
 673   (elmo-folder-persistent-internal folder))
 674
 675 (luna-define-method elmo-folder-creatable-p ((folder elmo-folder))
 676   t) ; default is creatable.
 677
 678 (luna-define-method elmo-folder-writable-p ((folder elmo-folder))
 679   nil) ; default is not writable.
 680
 681 (luna-define-method elmo-folder-rename ((folder elmo-folder) new-name)
 682   (let* ((new-folder (elmo-make-folder new-name)))
 683     (unless (eq (elmo-folder-type-internal folder)
 684                 (elmo-folder-type-internal new-folder))
 685       (error "Not same folder type"))
 686     (if (or (file-exists-p (elmo-folder-msgdb-path new-folder))
 687             (elmo-folder-exists-p new-folder))
 688         (error "Already exists folder: %s" new-name))
 689     (elmo-folder-send folder 'elmo-folder-rename-internal new-folder)
 690     (elmo-msgdb-rename-path folder new-folder)))
 691
 692 (luna-define-method elmo-folder-pack-numbers ((folder elmo-folder))
 693   nil) ; default is noop.
 694
 695 (luna-define-method elmo-folder-update-number ((folder elmo-folder))
 696   nil) ; default is noop.
 697
 698 (luna-define-method elmo-folder-message-file-p ((folder elmo-folder))
 699   nil) ; default is not file.
 700
 701 (luna-define-method elmo-folder-message-file-number-p ((folder elmo-folder))
 702   nil) ; default is not number.
 703
 704 (luna-define-method elmo-folder-message-make-temp-file-p ((folder elmo-folder))
 705   nil) ; default is not make temp file.
 706
 707 (luna-define-method elmo-message-file-name ((folder elmo-folder)
 708                                                    number)
 709   nil) ; default is no name.
 710
 711 (luna-define-method elmo-folder-local-p ((folder elmo-folder))
 712   t)   ; default is local.
 713
 714 (luna-define-method elmo-folder-have-subfolder-p ((folder elmo-folder))
 715   t)
 716
 717 ;;; Folder info
 718 ;; Folder info is a message number information cache (hashtable)
 719 (defsubst elmo-folder-get-info (folder &optional hashtb)
 720   "Return FOLDER info from HASHTB (default is `elmo-folder-info-hashtb')."
 721   (elmo-get-hash-val (elmo-folder-name-internal folder)
 722                      (or hashtb elmo-folder-info-hashtb)))
 723
 724 (defun elmo-folder-set-info-hashtb (folder max numbers &optional new unread)
 725   "Set FOLDER info (means MAX, NUMBERS, NEW and UNREAD)."
 726   (let ((info (elmo-folder-get-info folder)))
 727     (when info
 728       (or new     (setq new     (nth 0 info)))
 729       (or unread  (setq unread  (nth 1 info)))
 730       (or numbers (setq numbers (nth 2 info)))
 731       (or max     (setq max     (nth 3 info))))
 732     (elmo-set-hash-val (elmo-folder-name-internal folder)
 733                        (list new unread numbers max)
 734                        elmo-folder-info-hashtb)))
 735
 736 (defun elmo-folder-set-info-max-by-numdb (folder msgdb-number)
 737   "Set FOLDER info by MSGDB-NUMBER in msgdb."
 738   (let ((num-db (sort (mapcar 'car msgdb-number) '<)))
 739     (elmo-folder-set-info-hashtb
 740      folder
 741      (or (nth (max 0 (1- (length num-db))) num-db) 0)
 742      nil ;;(length num-db)
 743      )))
 744
 745 (defun elmo-folder-get-info-max (folder)
 746   "Return max number of FODLER from folder info."
 747   (nth 3 (elmo-folder-get-info folder)))
 748
 749 (defun elmo-folder-get-info-length (folder)
 750   "Return length of FODLER from folder info."
 751   (nth 2 (elmo-folder-get-info folder)))
 752
 753 (defun elmo-folder-get-info-unread (folder)
 754   "Return unread of FODLER from folder info."
 755   (nth 1 (elmo-folder-get-info folder)))
 756
 757 (defun elmo-folder-info-make-hashtb (info-alist hashtb)
 758   "Setup folder info hashtable by INFO-ALIST on HASHTB."
 759   (let* ((hashtb (or hashtb
 760                      (elmo-make-hash (length info-alist)))))
 761     (mapcar
 762      (lambda (x)
 763        (let ((info (cadr x)))
 764          (and (intern-soft (car x) hashtb)
 765               (elmo-set-hash-val (car x)
 766                                  (list (nth 2 info)   ;; new
 767                                        (nth 3 info)   ;; unread
 768                                        (nth 1 info)   ;; length
 769                                        (nth 0 info))  ;; max
 770                                  hashtb))))
 771      info-alist)
 772     (setq elmo-folder-info-hashtb hashtb)))
 773
 774 (defsubst elmo-strict-folder-diff (folder)
 775   "Return folder diff information strictly from FOLDER."
 776   (let* ((dir (elmo-folder-msgdb-path folder))
 777          (nalist (elmo-msgdb-get-number-alist (elmo-folder-msgdb folder)))
 778          (in-db (sort (mapcar 'car nalist) '<))
 779          (in-folder  (elmo-folder-list-messages folder))
 780          append-list delete-list diff)
 781     (cons (if (equal in-folder in-db)
 782               0
 783             (setq diff (elmo-list-diff
 784                         in-folder in-db
 785                         nil
 786                         ))
 787             (setq append-list (car diff))
 788             (setq delete-list (cadr diff))
 789             (if append-list
 790                 (length append-list)
 791               (if delete-list
 792                   (- 0 (length delete-list))
 793                 0)))
 794           (length in-folder))))
 795
 796 (luna-define-method elmo-folder-diff ((folder elmo-folder)
 797                                       &optional numbers)
 798   (elmo-generic-folder-diff folder numbers))
 799
 800 (defun elmo-generic-folder-diff (folder numbers)
 801   (if (elmo-string-match-member (elmo-folder-name-internal folder)
 802                                 elmo-strict-diff-folder-list)
 803       (elmo-strict-folder-diff folder)
 804     (let ((cached-in-db-max (elmo-folder-get-info-max folder))
 805           (in-folder (elmo-folder-status folder))
 806           (in-db t)
 807           unsync messages
 808           in-db-max)
 809       (if numbers
 810           (setq in-db-max (or (nth (max 0 (1- (length numbers))) numbers)
 811                               0))
 812         (if (not cached-in-db-max)
 813             (let ((number-list (mapcar 'car
 814                                        (elmo-msgdb-number-load
 815                                         (elmo-folder-msgdb-path folder)))))
 816               ;; No info-cache.
 817               (setq in-db (sort number-list '<))
 818               (setq in-db-max (or (nth (max 0 (1- (length in-db))) in-db)
 819                                   0))
 820               (elmo-folder-set-info-hashtb folder in-db-max nil))
 821           (setq in-db-max cached-in-db-max)))
 822       (setq unsync (if (and in-db
 823                             (car in-folder))
 824                        (- (car in-folder) in-db-max)
 825                      (if (and in-folder
 826                               (null in-db))
 827                          (cdr in-folder)
 828                        (if (null (car in-folder))
 829                            nil))))
 830       (setq messages (cdr in-folder))
 831       (if (and unsync messages (> unsync messages))
 832           (setq unsync messages))
 833       (cons (or unsync 0) (or messages 0)))))
 834
 835 (defvar elmo-folder-diff-async-callback nil)
 836 (defvar elmo-folder-diff-async-callback-data nil)
 837
 838 (luna-define-method elmo-folder-diff-async ((folder elmo-folder))
 839   (and elmo-folder-diff-async-callback
 840        (funcall elmo-folder-diff-async-callback
 841                 folder
 842                 (elmo-folder-diff folder))))
 843
 844 (luna-define-method elmo-folder-get-primitive-list ((folder elmo-folder))
 845   (list folder))
 846
 847 (luna-define-method elmo-folder-contains-type ((folder elmo-folder) type)
 848   (eq (elmo-folder-type-internal folder) type))
 849
 850 (luna-define-method elmo-folder-append-messages ((folder elmo-folder)
 851                                                  src-folder
 852                                                  numbers
 853                                                  unread-marks
 854                                                  &optional
 855                                                  same-number)
 856   (elmo-generic-folder-append-messages folder src-folder numbers
 857                                        unread-marks same-number))
 858
 859 (defun elmo-generic-folder-append-messages (folder src-folder numbers
 860                                                    unread-marks same-number)
 861   (let (unseen seen-list succeed-numbers failure cache)
 862     (with-temp-buffer
 863       (while numbers
 864         (setq failure nil)
 865         (condition-case nil
 866             (progn
 867               (elmo-message-fetch
 868                src-folder (car numbers)
 869                (if (and (not (elmo-folder-plugged-p src-folder))
 870                         elmo-enable-disconnected-operation
 871                         (setq cache (elmo-file-cache-get
 872                                      (elmo-message-field
 873                                       src-folder (car numbers)
 874                                       'message-id)))
 875                         (eq (elmo-file-cache-status cache) 'entire))
 876                    (elmo-make-fetch-strategy
 877                     'entire t nil (elmo-file-cache-path cache))
 878                  (elmo-make-fetch-strategy 'entire t))
 879                nil (current-buffer)
 880                'unread)
 881               (unless (eq (buffer-size) 0)
 882                 (setq failure (not
 883                                (elmo-folder-append-buffer
 884                                 folder
 885                                 (setq unseen (member (elmo-message-mark
 886                                                       src-folder (car numbers))
 887                                                      unread-marks))
 888                                 (if same-number (car numbers)))))))
 889           (error (setq failure t)))
 890         ;; FETCH & APPEND finished
 891         (unless failure
 892           (unless unseen
 893             (setq seen-list (cons (elmo-message-field
 894                                    src-folder (car numbers)
 895                                    'message-id)
 896                                   seen-list)))
 897           (setq succeed-numbers (cons (car numbers) succeed-numbers)))
 898         (elmo-progress-notify 'elmo-folder-move-messages)
 899         (setq numbers (cdr numbers)))
 900       (if (and seen-list (elmo-folder-persistent-p folder))
 901           (elmo-msgdb-seen-save (elmo-folder-msgdb-path folder)
 902                                 (nconc (elmo-msgdb-seen-load
 903                                         (elmo-folder-msgdb-path folder))
 904                                        seen-list)))
 905       succeed-numbers)))
 906
 907 ;; Arguments should be reduced.
 908 (defun elmo-folder-move-messages (src-folder msgs dst-folder
 909                                              &optional msgdb
 910                                              no-delete-info
 911                                              no-delete
 912                                              same-number
 913                                              unread-marks
 914                                              save-unread)
 915   (save-excursion
 916     (let* ((messages msgs)
 917            (elmo-inhibit-display-retrieval-progress t)
 918            (len (length msgs))
 919            succeeds i result)
 920       (if (eq dst-folder 'null)
 921           (setq succeeds messages)
 922         (unless (elmo-folder-writable-p dst-folder)
 923           (error "move: %d is not writable"
 924                  (elmo-folder-name-internal dst-folder)))
 925         (when messages
 926           ;; src is already opened.
 927           (elmo-folder-open-internal dst-folder)
 928           (unless (setq succeeds (elmo-folder-append-messages dst-folder
 929                                                               src-folder
 930                                                               messages
 931                                                               unread-marks
 932                                                               same-number))
 933             (error "move: append message to %s failed"
 934                    (elmo-folder-name-internal dst-folder)))
 935           (elmo-folder-close dst-folder))
 936         (when (and (elmo-folder-persistent-p dst-folder)
 937                    save-unread)
 938           ;; Save to seen list.
 939           (let* ((dir (elmo-folder-msgdb-path dst-folder))
 940                  (seen-list (elmo-msgdb-seen-load dir)))
 941             (setq seen-list
 942                   (elmo-msgdb-add-msgs-to-seen-list
 943                    msgs (elmo-folder-msgdb src-folder)
 944                    unread-marks seen-list))
 945             (elmo-msgdb-seen-save dir seen-list))))
 946       (if (and (not no-delete) succeeds)
 947           (progn
 948             (if (not no-delete-info)
 949                 (message "Cleaning up src folder..."))
 950             (if (and (elmo-folder-delete-messages src-folder succeeds)
 951                      (elmo-msgdb-delete-msgs
 952                       (elmo-folder-msgdb src-folder) succeeds))
 953                 (setq result t)
 954               (message "move: delete messages from %s failed."
 955                        (elmo-folder-name-internal src-folder))
 956               (setq result nil))
 957             (if (and result
 958                      (not no-delete-info))
 959                 (message "Cleaning up src folder...done"))
 960             result)
 961         (if no-delete
 962             (progn
 963               (message "Copying messages...done")
 964               t)
 965           (if (eq len 0)
 966               (message "No message was moved.")
 967             (message "Moving messages failed.")
 968             nil ; failure
 969             ))))))
 970
 971 (defun elmo-folder-msgdb-path (folder)
 972   "Return the msgdb path for FOLDER."
 973   (or (elmo-folder-path-internal folder)
 974       (elmo-folder-set-path-internal
 975        folder
 976        (elmo-folder-expand-msgdb-path folder))))
 977
 978 (defun elmo-message-mark (folder number)
 979   "Get mark of the message.
 980 FOLDER is the ELMO folder structure.
 981 NUMBER is a number of the message."
 982   (cadr (assq number (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))))
 983
 984 (defun elmo-folder-list-messages-mark-match (folder mark-regexp)
 985   "List messages in the FOLDER which have a mark that matches MARK-REGEXP"
 986   (let ((case-fold-search nil)
 987         matched)
 988     (if mark-regexp
 989         (dolist (elem (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))
 990           (if (string-match mark-regexp (cadr elem))
 991               (setq matched (cons (car elem) matched)))))
 992     matched))
 993
 994 (defun elmo-message-field (folder number field)
 995   "Get message field value in the msgdb.
 996 FOLDER is the ELMO folder structure.
 997 NUMBER is a number of the message.
 998 FIELD is a symbol of the field."
 999   (case field
1000     (message-id (elmo-msgdb-overview-entity-get-id
1001                  (elmo-msgdb-overview-get-entity
1002                   number (elmo-folder-msgdb folder))))
1003     (subject (elmo-msgdb-overview-entity-get-subject
1004               (elmo-msgdb-overview-get-entity
1005                number (elmo-folder-msgdb folder))))
1006     (size (elmo-msgdb-overview-entity-get-size
1007            (elmo-msgdb-overview-get-entity
1008             number (elmo-folder-msgdb folder))))
1009     (date (elmo-msgdb-overview-entity-get-date
1010            (elmo-msgdb-overview-get-entity
1011             number (elmo-folder-msgdb folder))))
1012     (to (elmo-msgdb-overview-entity-get-to
1013          (elmo-msgdb-overview-get-entity
1014           number (elmo-folder-msgdb folder))))
1015     (cc (elmo-msgdb-overview-entity-get-cc
1016          (elmo-msgdb-overview-get-entity
1017           number (elmo-folder-msgdb folder))))))
1018
1019 (defun elmo-message-set-mark (folder number mark)
1020   "Set mark for the message in the FOLDER with NUMBER as MARK."
1021   (elmo-msgdb-set-mark-alist
1022    (elmo-folder-msgdb folder)
1023    (elmo-msgdb-mark-set
1024     (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder))
1025     number mark)))
1026
1027 (luna-define-method elmo-message-use-cache-p ((folder elmo-folder) number)
1028   nil) ; default is not use cache.
1029
1030 (luna-define-method elmo-message-folder ((folder elmo-folder) number)
1031   folder) ; default is folder
1032
1033 (luna-define-method elmo-folder-unmark-important ((folder elmo-folder) numbers)
1034   t)
1035
1036 (luna-define-method elmo-folder-mark-as-important ((folder elmo-folder)
1037                                                    numbers)
1038   t)
1039
1040 (luna-define-method elmo-folder-unmark-read ((folder elmo-folder) numbers)
1041   t)
1042
1043 (luna-define-method elmo-folder-mark-as-read ((folder elmo-folder) numbers)
1044   t)
1045
1046 (luna-define-method elmo-folder-process-crosspost ((folder elmo-folder)
1047                                                    &optional
1048                                                    number-alist)
1049   ;; Do nothing.
1050   )
1051
1052 (defun elmo-generic-folder-append-msgdb (folder append-msgdb)
1053   (if append-msgdb
1054       (let* ((number-alist (elmo-msgdb-get-number-alist append-msgdb))
1055              (all-alist (copy-sequence (append
1056                                         (elmo-msgdb-get-number-alist
1057                                          (elmo-folder-msgdb folder))
1058                                         number-alist)))
1059              (cur number-alist)
1060              pair overview
1061              to-be-deleted
1062              mark-alist)
1063         (while cur
1064           (setq all-alist (delq (car cur) all-alist))
1065           ;; same message id exists.
1066           (if (setq pair (rassoc (cdr (car cur)) all-alist))
1067               (setq to-be-deleted (nconc to-be-deleted (list (car pair)))))
1068           (setq cur (cdr cur)))
1069         (cond ((eq (elmo-folder-process-duplicates-internal folder)
1070                    'hide)
1071                ;; Hide duplicates.
1072                (setq overview (elmo-delete-if
1073                                (lambda (x)
1074                                  (memq (elmo-msgdb-overview-entity-get-number
1075                                         x)
1076                                        to-be-deleted))
1077                                (elmo-msgdb-get-overview append-msgdb)))
1078                ;; Should be mark as read.
1079                (elmo-folder-mark-as-read folder to-be-deleted)
1080                (elmo-msgdb-set-overview append-msgdb overview))
1081               ((eq (elmo-folder-process-duplicates-internal folder)
1082                    'read)
1083                ;; Mark as read duplicates.
1084                (elmo-folder-mark-as-read folder to-be-deleted))
1085               (t
1086                ;; Do nothing.
1087                (setq to-be-deleted nil)))
1088         (elmo-folder-set-msgdb-internal folder
1089                                         (elmo-msgdb-append
1090                                          (elmo-folder-msgdb folder)
1091                                          append-msgdb t))
1092         (length to-be-deleted))
1093     0))
1094
1095 (luna-define-method elmo-folder-append-msgdb ((folder elmo-folder)
1096                                               append-msgdb)
1097   (elmo-generic-folder-append-msgdb folder append-msgdb))
1098
1099 (defun elmo-folder-confirm-appends (appends)
1100   (let ((len (length appends))
1101         in)
1102     (if (and (> len elmo-folder-update-threshold)
1103              elmo-folder-update-confirm)
1104         (if (y-or-n-p (format "Too many messages(%d).  Continue? " len))
1105             appends
1106           (setq in elmo-folder-update-threshold)
1107           (catch 'end
1108             (while t
1109               (setq in (read-from-minibuffer "Update number: "
1110                                              (int-to-string in))
1111                     in (string-to-int in))
1112               (if (< len in)
1113                   (throw 'end len))
1114               (if (y-or-n-p (format "%d messages are disappeared.  OK? "
1115                                     (max (- len in) 0)))
1116                   (throw 'end in))))
1117           (nthcdr (max (- len in) 0) appends))
1118       (if (and (> len elmo-folder-update-threshold)
1119                (not elmo-folder-update-confirm))
1120           (nthcdr (max (- len elmo-folder-update-threshold) 0) appends)
1121         appends))))
1122
1123 (luna-define-method elmo-message-fetch ((folder elmo-folder)
1124                                         number strategy
1125                                         &optional
1126                                         section
1127                                         outbuf
1128                                         unread)
1129   (if outbuf
1130       (with-current-buffer outbuf
1131         (erase-buffer)
1132         (elmo-message-fetch-with-cache-process folder number
1133                                                strategy section unread)
1134         t)
1135     (with-temp-buffer
1136       (elmo-message-fetch-with-cache-process folder number
1137                                              strategy section unread)
1138       (buffer-string))))
1139
1140 (luna-define-method elmo-message-fetch-with-cache-process ((folder elmo-folder)
1141                                                            number strategy
1142                                                            &optional
1143                                                            section unread)
1144   (let (cache-path cache-file)
1145     (if (and (elmo-fetch-strategy-use-cache strategy)
1146              (setq cache-path (elmo-fetch-strategy-cache-path strategy))
1147              (setq cache-file (elmo-file-cache-expand-path
1148                                cache-path
1149                                section))
1150              (file-exists-p cache-file)
1151              (or (not (elmo-cache-path-section-p cache-file))
1152                  (not (eq (elmo-fetch-strategy-entireness strategy) 'entire))))
1153         (insert-file-contents-as-binary cache-file)
1154       (elmo-message-fetch-internal folder number strategy section unread)
1155       (elmo-delete-cr-buffer)
1156       (when (and (> (buffer-size) 0)
1157                  (elmo-fetch-strategy-save-cache strategy)
1158                  (elmo-fetch-strategy-cache-path strategy))
1159         (elmo-file-cache-save
1160          (elmo-fetch-strategy-cache-path strategy)
1161          section)))))
1162
1163 (luna-define-method elmo-folder-clear ((folder elmo-folder)
1164                                        &optional keep-killed)
1165   (unless keep-killed
1166     (elmo-folder-set-killed-list-internal folder nil))
1167   (elmo-folder-set-msgdb-internal folder (elmo-msgdb-clear)))
1168
1169 (defun elmo-folder-synchronize (folder
1170                                 new-mark             ;"N"
1171                                 unread-uncached-mark ;"U"
1172                                 unread-cached-mark   ;"!"
1173                                 read-uncached-mark   ;"u"
1174                                 important-mark       ;"$"
1175                                 &optional ignore-msgdb
1176                                 no-check)
1177   "Synchronize the folder data to the newest status.
1178 FOLDER is the ELMO folder structure.
1179 NEW-MARK, UNREAD-CACHED-MARK, READ-UNCACHED-MARK, and IMPORTANT-MARK
1180 are mark strings for new messages, unread but cached messages,
1181 read but not cached messages, and important messages.
1182 If optional IGNORE-MSGDB is non-nil, current msgdb is thrown away except
1183 read mark status. If IGNORE-MSGDB is 'visible-only, only visible messages
1184 \(the messages which are not in the killed-list\) are thrown away and
1185 synchronized.
1186 If NO-CHECK is non-nil, rechecking folder is skipped.
1187
1188 Return a list of
1189 \(NEW-MSGDB DELETE-LIST CROSSED\)
1190 NEW-MSGDB is the newly appended msgdb.
1191 DELETE-LIST is a list of deleted message number.
1192 CROSSED is cross-posted message number.
1193 If update process is interrupted, return nil."
1194   (let ((killed-list (elmo-folder-killed-list-internal folder))
1195         (before-append t)
1196         number-alist mark-alist
1197         old-msgdb diff diff-2 delete-list new-list new-msgdb mark
1198         seen-list crossed after-append)
1199     (setq old-msgdb (elmo-folder-msgdb folder))
1200     ;; Load seen-list.
1201     (setq seen-list (elmo-msgdb-seen-load (elmo-folder-msgdb-path folder)))
1202     (setq number-alist (elmo-msgdb-get-number-alist
1203                         (elmo-folder-msgdb folder)))
1204     (setq mark-alist (elmo-msgdb-get-mark-alist
1205                       (elmo-folder-msgdb folder)))
1206     (if ignore-msgdb
1207         (progn
1208           (setq seen-list (nconc
1209                            (elmo-msgdb-mark-alist-to-seen-list
1210                             number-alist mark-alist
1211                             (concat important-mark read-uncached-mark))
1212                            seen-list))
1213           (elmo-folder-clear folder (eq ignore-msgdb 'visible-only))))
1214     (unless no-check (elmo-folder-check folder))
1215     (condition-case nil
1216         (progn
1217           (message "Checking folder diff...")
1218           ;; TODO: killed list is loaded in elmo-folder-open and
1219           ;; list-messages use internal killed-list-folder.
1220           (setq diff (elmo-list-diff (elmo-folder-list-messages
1221                                       folder
1222                                       (eq 'visible-only ignore-msgdb))
1223                                      (unless ignore-msgdb
1224                                        (sort (mapcar
1225                                               'car
1226                                               number-alist)
1227                                              '<))))
1228           (message "Checking folder diff...done")
1229           (setq new-list (elmo-folder-confirm-appends (car diff)))
1230           ;; Set killed list.
1231           (when (and (not (eq (length (car diff))
1232                               (length new-list)))
1233                      (setq diff-2 (elmo-list-diff (car diff) new-list)))
1234             (elmo-msgdb-append-to-killed-list folder (car diff-2)))
1235           ;; Don't delete important marked messages.
1236           (setq delete-list
1237                 (if (eq (elmo-folder-type-internal folder) 'mark)
1238                     (cadr diff)
1239                   (elmo-delete-if
1240                    (lambda (x)
1241                      (and (setq mark (cadr (assq x mark-alist)))
1242                           (string= mark important-mark)))
1243                    ;; delete message list
1244                    (cadr diff))))
1245           (if (or (equal diff '(nil nil))
1246                   (equal diff '(nil))
1247                   (and (eq (length (car diff)) 0)
1248                        (eq (length (cadr diff)) 0)))
1249               (progn
1250                 (elmo-folder-update-number folder)
1251                 (elmo-folder-process-crosspost folder)
1252                 (list nil nil nil) ; no updates.
1253                 )
1254             (if delete-list (elmo-msgdb-delete-msgs
1255                              (elmo-folder-msgdb folder) delete-list))
1256             (when new-list
1257               (setq new-msgdb (elmo-folder-msgdb-create
1258                                folder
1259                                new-list
1260                                new-mark unread-cached-mark
1261                                read-uncached-mark important-mark
1262                                seen-list))
1263               (elmo-msgdb-change-mark (elmo-folder-msgdb folder)
1264                                       new-mark unread-uncached-mark)
1265               ;; Clear seen-list.
1266               (if (elmo-folder-persistent-p folder)
1267                   (setq seen-list (elmo-msgdb-seen-save
1268                                    (elmo-folder-msgdb-path folder) nil)))
1269               (setq before-append nil)
1270               (setq crossed (elmo-folder-append-msgdb folder new-msgdb))
1271               ;; process crosspost.
1272               ;; Return a cons cell of (NUMBER-CROSSPOSTS . NEW-MARK-ALIST).
1273               (elmo-folder-process-crosspost folder)
1274               (elmo-folder-set-message-modified-internal folder t)
1275               (elmo-folder-set-mark-modified-internal folder t))
1276             ;; return value.
1277             (list new-msgdb delete-list crossed)))
1278       (quit
1279        ;; Resume to the original status.
1280        (if before-append
1281            (elmo-folder-set-msgdb-internal folder old-msgdb))
1282        (elmo-folder-set-killed-list-internal folder killed-list)
1283        nil))))
1284
1285 (defun elmo-folder-messages (folder)
1286   "Return number of messages in the FOLDER."
1287   (length
1288    (elmo-msgdb-get-number-alist
1289     (elmo-folder-msgdb folder))))
1290
1291 ;;;
1292 (defun elmo-msgdb-search (folder condition msgdb)
1293   "Search messages which satisfy CONDITION from FOLDER with MSGDB."
1294   (let* ((condition (car (elmo-parse-search-condition condition)))
1295          (overview (elmo-msgdb-get-overview msgdb))
1296          (number-alist (elmo-msgdb-get-number-alist msgdb))
1297          (number-list (mapcar 'car number-alist))
1298          (length (length overview))
1299          (i 0)
1300          result)
1301     (if (not (elmo-condition-in-msgdb-p condition))
1302         (elmo-folder-search folder condition number-list)
1303       (while overview
1304         (if (elmo-msgdb-search-internal condition (car overview)
1305                                         number-list)
1306             (setq result
1307                   (cons
1308                    (elmo-msgdb-overview-entity-get-number (car overview))
1309                    result)))
1310         (setq i (1+ i))
1311         (elmo-display-progress
1312          'elmo-msgdb-search "Searching..." (/ (* i 100) length))
1313         (setq overview (cdr overview)))
1314       (nreverse result))))
1315
1316 (defun elmo-msgdb-load (folder)
1317   (message "Loading msgdb for %s..." (elmo-folder-name-internal folder))
1318   (let* ((path (elmo-folder-msgdb-path folder))
1319          (overview (elmo-msgdb-overview-load path))
1320          (msgdb (list overview
1321                       (elmo-msgdb-number-load path)
1322                       (elmo-msgdb-mark-load path)
1323                       (elmo-msgdb-make-overview-hashtb overview))))
1324     (message "Loading msgdb for %s...done" (elmo-folder-name-internal folder))
1325     (elmo-folder-set-info-max-by-numdb folder
1326                                        (elmo-msgdb-get-number-alist msgdb))
1327     msgdb))
1328
1329 (defun elmo-msgdb-delete-path (folder)
1330   (let ((path (elmo-folder-msgdb-path folder)))
1331     (if (file-directory-p path)
1332         (elmo-delete-directory path t))))
1333
1334 (defun elmo-msgdb-rename-path (old-folder new-folder)
1335   (let* ((old (directory-file-name (elmo-folder-msgdb-path old-folder)))
1336          (new (directory-file-name (elmo-folder-msgdb-path new-folder)))
1337          (new-dir (directory-file-name (file-name-directory new))))
1338     (if (not (file-directory-p old))
1339         ()
1340       (if (file-exists-p new)
1341           (error "Already exists directory: %s" new)
1342         (if (not (file-exists-p new-dir))
1343             (elmo-make-directory new-dir))
1344         (rename-file old new)))))
1345
1346 (defun elmo-setup-subscribed-newsgroups (groups)
1347   "Setup subscribed newsgroups.
1348 GROUPS is a list of newsgroup name string.
1349 Return a hashtable for newsgroups."
1350   (let ((hashtb (or elmo-newsgroups-hashtb
1351                     (setq elmo-newsgroups-hashtb
1352                           (elmo-make-hash (length groups))))))
1353     (dolist (group groups)
1354       (or (elmo-get-hash-val group hashtb)
1355           (elmo-set-hash-val group nil hashtb)))
1356     (setq elmo-newsgroups-hashtb hashtb)))
1357
1358 (defvar elmo-crosspost-message-alist-modified nil)
1359 (defun elmo-crosspost-message-alist-load ()
1360   "Load crosspost message alist."
1361   (setq elmo-crosspost-message-alist (elmo-crosspost-alist-load))
1362   (setq elmo-crosspost-message-alist-modified nil))
1363
1364 (defun elmo-crosspost-message-alist-save ()
1365   "Save crosspost message alist."
1366   (when elmo-crosspost-message-alist-modified
1367     (let ((alist elmo-crosspost-message-alist)
1368           newsgroups)
1369       (while alist
1370         (setq newsgroups
1371               (elmo-delete-if
1372                '(lambda (x)
1373                   (not (intern-soft x elmo-newsgroups-hashtb)))
1374                (nth 1 (car alist))))
1375         (if newsgroups
1376             (setcar (cdar alist) newsgroups)
1377           (setq elmo-crosspost-message-alist
1378                 (delete (car alist) elmo-crosspost-message-alist)))
1379         (setq alist (cdr alist)))
1380       (elmo-crosspost-alist-save elmo-crosspost-message-alist)
1381       (setq elmo-crosspost-message-alist-modified nil))))
1382
1383 (defun elmo-folder-make-temp-dir (folder)
1384   ;; Make a temporary directory for FOLDER.
1385   (let ((temp-dir (make-temp-name
1386                    (concat
1387                     (file-name-as-directory (elmo-folder-msgdb-path folder))
1388                     "elmo"))))
1389     (elmo-make-directory temp-dir)
1390     temp-dir))
1391
1392 (defun elmo-init ()
1393   "Initialize ELMO module."
1394   (elmo-crosspost-message-alist-load)
1395   (elmo-resque-obsolete-variables)
1396   (elmo-dop-queue-load))
1397
1398 (defun elmo-quit ()
1399   "Quit and cleanup ELMO."
1400   (elmo-crosspost-message-alist-save)
1401   (elmo-dop-queue-save)
1402   ;; Not implemented yet.
1403   (let ((types elmo-folder-type-alist)
1404         class)
1405     (while types
1406       (setq class
1407             (luna-find-class
1408              (intern (format "elmo-%s-folder" (symbol-name (cdr (car types)))))))
1409       ;; Call all folder's `elmo-quit' method.
1410       (if class
1411           (dolist (func (luna-class-find-functions class 'elmo-quit))
1412             (funcall func nil)))
1413       (setq types (cdr types)))))
1414
1415
1416 ;;; Define folders.
1417 (elmo-define-folder ?% 'imap4)
1418 (elmo-define-folder ?-  'nntp)
1419 (elmo-define-folder ?\+ 'localdir)
1420 (elmo-define-folder ?\* 'multi)
1421 (elmo-define-folder ?\/ 'filter)
1422 (elmo-define-folder ?\$ 'archive)
1423 (elmo-define-folder ?&  'pop3)
1424 (elmo-define-folder ?=  'localnews)
1425 (elmo-define-folder ?|  'pipe)
1426 (elmo-define-folder ?.  'maildir)
1427 (elmo-define-folder ?'  'internal)
1428 (elmo-define-folder ?\[  'nmz)
1429 (elmo-define-folder ?@  'shimbun)
1430
1431 ;;; Obsolete variables.
1432 (elmo-define-obsolete-variable 'elmo-default-imap4-mailbox
1433                                'elmo-imap4-default-mailbox)
1434 (elmo-define-obsolete-variable 'elmo-default-imap4-server
1435                                'elmo-imap4-default-server)
1436 (elmo-define-obsolete-variable 'elmo-default-imap4-authenticate-type
1437                                'elmo-imap4-default-authenticate-type)
1438 (elmo-define-obsolete-variable 'elmo-default-imap4-user
1439                                'elmo-imap4-default-user)
1440 (elmo-define-obsolete-variable 'elmo-default-imap4-port
1441                                'elmo-imap4-default-port)
1442 (elmo-define-obsolete-variable 'elmo-default-nntp-server
1443                                'elmo-nntp-default-server)
1444 (elmo-define-obsolete-variable 'elmo-default-nntp-user
1445                                'elmo-nntp-default-user)
1446 (elmo-define-obsolete-variable 'elmo-default-nntp-port
1447                                'elmo-nntp-default-port)
1448 (elmo-define-obsolete-variable 'elmo-default-pop3-server
1449                                'elmo-pop3-default-server)
1450 (elmo-define-obsolete-variable 'elmo-default-pop3-user
1451                                'elmo-pop3-default-user)
1452 (elmo-define-obsolete-variable 'elmo-default-pop3-authenticate-type
1453                                'elmo-pop3-default-authenticate-type)
1454 (elmo-define-obsolete-variable 'elmo-default-pop3-port
1455                                'elmo-pop3-default-port)
1456
1457 ;; autoloads
1458 (autoload 'elmo-dop-queue-flush "elmo-dop")
1459
1460 (require 'product)
1461 (product-provide (provide 'elmo) (require 'elmo-version))
1462
1463 ;;; elmo.el ends here