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