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