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