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