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