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