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