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