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