elmo/elmo.el

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