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