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