elmo/elmo.el

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