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