elmo/elmo2.el

   1 ;;; elmo2.el -- ELMO main file (I don't remember why this is 2).
   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 'elmo-version)                 ; reduce recursive-load-depth
  33 (require 'elmo-vars)
  34 (require 'elmo-msgdb)
  35 (require 'elmo-cache)
  36 (require 'elmo-util)
  37 (require 'elmo-dop)
  38 ;;;(provide 'elmo2)                     ; circular dependency
  39
  40 (eval-when-compile
  41   (require 'elmo-localdir)
  42   (require 'elmo-imap4)
  43   (require 'elmo-nntp)
  44   (require 'elmo-pop3)
  45   (require 'elmo-pipe)
  46 ;  (require 'elmo-multi)
  47   (require 'elmo-filter)
  48   (require 'elmo-archive)
  49   ;(require 'elmo-cache2)
  50   )
  51
  52 (if (or (featurep 'dbm)
  53         (featurep 'gnudbm)
  54         (featurep 'berkdb)
  55         (featurep 'berkeley-db))
  56     (require 'elmo-database))
  57
  58 (elmo-define-error 'elmo-error "Error" 'error)
  59 (elmo-define-error 'elmo-open-error "Cannot open" 'elmo-error)
  60 (elmo-define-error 'elmo-authenticate-error "Login failed" 'elmo-open-error)
  61 (elmo-define-error 'elmo-imap4-bye-error "IMAP4 BYE response" 'elmo-open-error)
  62
  63 (defun elmo-quit ()
  64   (interactive)
  65   (if (featurep 'elmo-net)
  66       (elmo-network-clear-session-cache))
  67   (if (get-buffer elmo-work-buf-name)
  68       (kill-buffer elmo-work-buf-name)))
  69
  70 (defun elmo-cleanup-variables ()
  71   (setq elmo-folder-info-hashtb nil
  72         elmo-nntp-groups-hashtb nil
  73         elmo-nntp-list-folders-cache nil
  74         ))
  75
  76 ;;  (cons of max . estimated message number) elmo-max-of-folder (folder)
  77 (defun elmo-max-of-folder (folder)
  78   (if (elmo-folder-plugged-p folder)
  79       (elmo-call-func folder "max-of-folder")
  80     (elmo-dop-max-of-folder folder)))
  81
  82 ;;  list elmo-list-folder (folder)
  83 (defun elmo-list-folder (folder)
  84   (if (elmo-folder-plugged-p folder)
  85       (elmo-call-func folder "list-folder")
  86     (elmo-dop-list-folder folder)))
  87
  88 ;;  list elmo-list-folders (folder)
  89 (defun elmo-list-folders (folder &optional hierarchy)
  90   (elmo-call-func folder "list-folders" hierarchy))
  91
  92 ;; bool elmo-folder-exists-p (folder)
  93 (defun elmo-folder-exists-p (folder)
  94   (if (elmo-folder-plugged-p folder)
  95       (elmo-call-func folder "folder-exists-p")
  96     (elmo-dop-folder-exists-p folder)))
  97
  98 ;; bool elmo-folder-creatable-p (folder)
  99 (defun elmo-folder-creatable-p (folder)
 100   (elmo-call-func folder "folder-creatable-p"))
 101
 102 ;; bool elmo-create-folder (folder)
 103 ;; create folder
 104 (defun elmo-create-folder (folder)
 105   (if (elmo-folder-plugged-p folder)
 106       (elmo-call-func folder "create-folder")
 107     (elmo-dop-create-folder folder)))
 108
 109 (defun elmo-delete-folder (folder)
 110   (let ((type (elmo-folder-get-type folder)))
 111     (if (or (not (memq type '(localdir localnews archive imap4 maildir)))
 112             (if (elmo-folder-plugged-p folder)
 113                 (elmo-call-func folder "delete-folder")
 114               (elmo-dop-delete-folder folder)))
 115         ;; If folder doesn't support delete folder, delete msgdb path only.
 116         (elmo-msgdb-delete-path folder))))
 117
 118 (defun elmo-rename-folder (old-folder new-folder)
 119   (let ((old-type (elmo-folder-get-type old-folder))
 120         (new-type (elmo-folder-get-type new-folder)))
 121     (if (not (eq old-type new-type))
 122         (error "not same folder type")
 123       (unless (and (memq old-type '(localdir localnews archive imap4))
 124                    (elmo-folder-identical-system-p old-folder new-folder))
 125         (error "rename folder not supported"))
 126       (if (elmo-folder-plugged-p old-folder)
 127           (and
 128            (if (or (file-exists-p (elmo-msgdb-expand-path new-folder))
 129                    (elmo-folder-exists-p new-folder))
 130                (error "already exists folder: %s" new-folder)
 131              t)
 132            (elmo-call-func old-folder "rename-folder"
 133                            (elmo-folder-get-spec new-folder))
 134            (elmo-msgdb-rename-path old-folder new-folder))
 135         (elmo-dop-rename-folder old-folder new-folder)))))
 136
 137 (defun elmo-read-msg-no-cache (folder msg outbuf)
 138   "Read messsage specified by FOLDER and MSG(number) into OUTBUF
 139 without cacheing."
 140   (elmo-call-func folder "read-msg" msg outbuf))
 141
 142 (defun elmo-force-cache-msg (folder number msgid &optional loc-alist)
 143   "Force cache message."
 144   (let* ((cache-file (elmo-cache-get-path msgid))
 145          dir)
 146     (when cache-file
 147       (setq dir (directory-file-name (file-name-directory cache-file)))
 148       (if (not (file-exists-p dir))
 149           (elmo-make-directory dir))
 150       (if (elmo-local-file-p folder number)
 151           (elmo-copy-file (elmo-get-msg-filename folder number loc-alist)
 152                           cache-file)
 153         (with-temp-buffer
 154           (elmo-call-func folder "read-msg" number (current-buffer))
 155           (as-binary-output-file
 156            (write-region (point-min) (point-max) cache-file nil 'no-msg)))))))
 157
 158 (defun elmo-prefetch-msg (folder msg outbuf msgdb)
 159   "Read message into outbuf with cacheing."
 160   (save-excursion
 161     (let* ((number-alist (elmo-msgdb-get-number-alist
 162                           (or msgdb (elmo-msgdb-load folder))))
 163            (dir (elmo-msgdb-expand-path folder))
 164            (message-id (cdr (assq msg number-alist)))
 165            type
 166            cache-status
 167            ret-val part-num real-fld-num)
 168       (set-buffer outbuf)
 169       (if (elmo-cache-exists-p message-id)
 170           t
 171         ;; cache doesn't exist.
 172         (setq real-fld-num (elmo-get-real-folder-number
 173                             folder msg))
 174         (setq type (elmo-folder-get-type (car real-fld-num)))
 175         (cond ((eq type 'imap4)
 176                (setq ret-val (elmo-imap4-prefetch-msg
 177                               (elmo-folder-get-spec (car real-fld-num))
 178                               (cdr real-fld-num)
 179                               outbuf)))
 180               ((elmo-folder-local-p (car real-fld-num)))
 181               (t (setq ret-val (elmo-call-func (car real-fld-num)
 182                                                "read-msg"
 183                                                (cdr real-fld-num) outbuf))))
 184         (if ret-val
 185             (elmo-cache-save message-id
 186                              (elmo-string-partial-p ret-val)
 187                              folder msg))
 188         (and ret-val t)))))
 189
 190 (defun elmo-prefetch-msgs (folder msgs)
 191   "prefetch messages for queueing."
 192   (let* ((msgdb (elmo-msgdb-load folder))
 193          (number-alist (elmo-msgdb-get-number-alist msgdb))
 194          (len (length msgs))
 195          (count 0)
 196          msgid msg)
 197     (while msgs
 198       (setq msg (car msgs))
 199       (setq msgid (cdr (assq msg number-alist)))
 200       (message "%s:Prefetching... %d/%d message(s)"
 201                folder
 202                (setq count (+ 1 count)) len)
 203       (elmo-force-cache-msg folder msg msgid)
 204       (setq msgs (cdr msgs)))))
 205
 206 ;;  elmo-read-msg (folder msg outbuf msgdb)
 207 ;;; read message
 208 (defun elmo-read-msg (folder msg outbuf msgdb &optional force-reload)
 209   "Read message into outbuf."
 210   (let ((inhibit-read-only t))
 211     (if elmo-inhibit-read-cache
 212     ;;Only use elmo-read-msg-with-cache, because if folder is network and
 213     ;;elmo-use-cache-p is nil, cannot read important msg. (by muse)
 214     ;;(if (not (elmo-use-cache-p folder msg))
 215         (elmo-read-msg-no-cache folder msg outbuf)
 216       (elmo-read-msg-with-cache folder msg outbuf msgdb force-reload))))
 217
 218 (defun elmo-read-msg-with-cache (folder msg outbuf msgdb
 219                                         &optional force-reload)
 220   "Read message into outbuf with cacheing."
 221   (let* ((number-alist (elmo-msgdb-get-number-alist
 222                         (or msgdb (elmo-msgdb-load folder))))
 223          (dir (elmo-msgdb-expand-path folder))
 224          (message-id (cdr (assq msg number-alist)))
 225          (type (elmo-folder-number-get-type folder msg))
 226          cache-status
 227          ret-val part-num real-fld-num)
 228     (set-buffer outbuf)
 229     (if (and (not force-reload)
 230              (not (elmo-local-file-p folder msg)))
 231         (setq ret-val (elmo-cache-read message-id folder msg)))
 232     (if ret-val
 233         t
 234       ;; cache doesn't exist.
 235       (setq real-fld-num (elmo-get-real-folder-number
 236                           folder msg))
 237       (if (setq ret-val (elmo-call-func (car real-fld-num)
 238                                         "read-msg"
 239                                         (cdr real-fld-num) outbuf))
 240           (if (and message-id
 241                    (not (elmo-local-file-p folder msg))
 242                    (elmo-use-cache-p folder msg))
 243               (elmo-cache-save message-id
 244                                (elmo-string-partial-p ret-val)
 245                                folder msg)))
 246       (and ret-val t))))
 247
 248 (defun elmo-copy-msgs (src-folder msgs dst-folder &optional msgdb same-number)
 249   (let* ((src-spec (elmo-folder-get-spec src-folder))
 250          (loc-alist (if msgdb
 251                         (elmo-msgdb-get-location msgdb)
 252                       (elmo-msgdb-location-load
 253                        (elmo-msgdb-expand-path src-spec)))))
 254     (if (eq (car src-spec) 'archive)
 255         (elmo-archive-copy-msgs-froms
 256          (elmo-folder-get-spec dst-folder)
 257          msgs src-spec loc-alist same-number)
 258       (elmo-call-func dst-folder "copy-msgs"
 259                       msgs src-spec loc-alist same-number))))
 260
 261 (defun elmo-move-msgs (src-folder msgs dst-folder
 262                                   &optional msgdb all done
 263                                   no-delete-info
 264                                   no-delete
 265                                   same-number
 266                                   unread-marks)
 267   (save-excursion
 268     (let* ((db (or msgdb (elmo-msgdb-load src-folder)))
 269            (number-alist (elmo-msgdb-get-number-alist db))
 270            (mark-alist   (elmo-msgdb-get-mark-alist db))
 271            (messages msgs)
 272            (len (length msgs))
 273            (all-msg-num (or all len))
 274            (done-msg-num (or done 0))
 275            (progress-message (if no-delete
 276                                  "Copying messages..."
 277                                "Moving messages..."))
 278            (tmp-buf (get-buffer-create " *elmo-move-msg*"))
 279            ;elmo-no-cache-flag
 280            ret-val real-fld-num done-copy dir pair
 281            mes-string message-id src-cache i unseen seen-list)
 282       (setq i done-msg-num)
 283       (set-buffer tmp-buf)
 284       (when (and (not (eq dst-folder 'null))
 285                  (elmo-folder-direct-copy-p src-folder dst-folder))
 286         (message (concat (if no-delete "Copying" "Moving")
 287                          " %d message(s)...") (length messages))
 288         (unless (elmo-copy-msgs src-folder
 289                                 messages
 290                                 dst-folder
 291                                 db
 292                                 same-number)
 293           (error "Copy message to %s failed" dst-folder))
 294         (setq done-copy t))
 295       (while messages
 296         (setq real-fld-num (elmo-get-real-folder-number src-folder
 297                                                         (car messages)))
 298         (setq message-id (cdr (setq pair (assq (car messages) number-alist))))
 299         ;; seen-list.
 300         (if (and (not (eq dst-folder 'null))
 301                  (not (and unread-marks
 302                            (setq unseen
 303                                  (member
 304                                   (cadr (assq (car messages) mark-alist))
 305                                   unread-marks)))))
 306             (setq seen-list (cons message-id seen-list)))
 307         (unless (or (eq dst-folder 'null) done-copy)
 308           (if (and (elmo-folder-plugged-p src-folder)
 309                    (elmo-folder-plugged-p dst-folder)
 310                    (elmo-folder-identical-system-p (car real-fld-num)
 311                                                    dst-folder))
 312               ;; online and identical system...so copy 'em!
 313               (unless
 314                   (elmo-copy-msgs (car real-fld-num)
 315                                   (list (cdr real-fld-num))
 316                                   dst-folder
 317                                   db
 318                                   same-number)
 319                 (error "Copy message to %s failed" dst-folder))
 320             ;; use cache if exists.
 321             ;; if there's other message with same message-id,
 322             ;; don't use cache.
 323             (elmo-read-msg src-folder (car messages)
 324                            tmp-buf msgdb
 325                            (and (elmo-folder-plugged-p src-folder)
 326                                 (and pair
 327                                      (or
 328                                       (rassoc
 329                                        message-id
 330                                        (cdr (memq pair number-alist)))
 331                                       (not (eq pair
 332                                                (rassoc message-id
 333                                                        number-alist)))))))
 334             (unless (eq (buffer-size) 0)
 335               (unless (elmo-append-msg dst-folder (buffer-string) message-id
 336                                        (if same-number (car messages))
 337                                        ;; null means all unread.
 338                                        (or (null unread-marks)
 339                                            unseen))
 340                 (error "move: append message to %s failed" dst-folder)))))
 341         ;; delete src cache if it is partial.
 342         (elmo-cache-delete-partial message-id src-folder (car messages))
 343         (setq ret-val (nconc ret-val (list (car messages))))
 344         (when (> all-msg-num elmo-display-progress-threshold)
 345           (setq i (+ i 1))
 346           (elmo-display-progress
 347            'elmo-move-msgs progress-message
 348            (/ (* i 100) all-msg-num)))
 349         (setq messages (cdr messages)))
 350       ;; Save seen-list.
 351       (unless (eq dst-folder 'null)
 352         (setq dir (elmo-msgdb-expand-path dst-folder))
 353         (elmo-msgdb-seen-save dir
 354                               (append (elmo-msgdb-seen-load dir) seen-list)))
 355       (kill-buffer tmp-buf)
 356       (if (and (not no-delete) ret-val)
 357           (progn
 358             (if (not no-delete-info)
 359                 (message "Cleaning up src folder..."))
 360             (if (and (elmo-delete-msgs src-folder ret-val db)
 361                      (elmo-msgdb-delete-msgs src-folder ret-val db t))
 362                 (setq ret-val t)
 363               (message "move: delete messages from %s failed." src-folder)
 364               (setq ret-val nil)
 365               )
 366             (if (and ret-val
 367                      (not no-delete-info))
 368                 (message "Cleaning up src folder...done")
 369               )
 370             ret-val)
 371         (if no-delete
 372             (progn
 373               (message "Copying messages...done")
 374               t)
 375           (if (eq len 0)
 376               (message "No message was moved.")
 377             (message "Moving messages failed.")
 378             nil ; failure
 379             ))))))
 380
 381 ;;  boolean elmo-delete-msgs (folder msgs)
 382 (defun elmo-delete-msgs (folder msgs &optional msgdb)
 383   ;; remove from real folder.
 384   (if (elmo-folder-plugged-p folder)
 385       (elmo-call-func folder "delete-msgs" msgs)
 386     (elmo-dop-delete-msgs folder msgs msgdb)))
 387
 388 (defun elmo-search (folder condition &optional from-msgs)
 389   (if (elmo-folder-plugged-p folder)
 390       (elmo-call-func folder "search" condition from-msgs)
 391     (elmo-cache-search-all folder condition from-msgs)))
 392
 393 (defun elmo-msgdb-search (folder condition msgdb)
 394   "Search messages which satisfy CONDITION from FOLDER with MSGDB."
 395   (let* ((condition (car (elmo-parse-search-condition condition)))
 396          (overview (elmo-msgdb-get-overview msgdb))
 397          (number-alist (elmo-msgdb-get-number-alist msgdb))
 398          (number-list (mapcar 'car number-alist))
 399          (length (length overview))
 400          (i 0)
 401          result)
 402     (if (elmo-condition-find-key condition "body")
 403         (elmo-search folder condition number-list)
 404       (while overview
 405         (if (elmo-msgdb-search-internal condition (car overview)
 406                                         number-list)
 407             (setq result
 408                   (cons
 409                    (elmo-msgdb-overview-entity-get-number (car overview))
 410                    result)))
 411         (setq i (1+ i))
 412         (elmo-display-progress
 413          'elmo-msgdb-search "Searching..." (/ (* i 100) length))
 414         (setq overview (cdr overview)))
 415       (nreverse result))))
 416
 417 (defun elmo-msgdb-create (folder numlist new-mark already-mark
 418                                  seen-mark important-mark seen-list)
 419   (if (elmo-folder-plugged-p folder)
 420       (elmo-call-func folder "msgdb-create" numlist new-mark already-mark
 421                       seen-mark important-mark seen-list)
 422     (elmo-dop-msgdb-create folder numlist new-mark already-mark
 423                            seen-mark important-mark seen-list)))
 424
 425 (defun elmo-make-folder-numbers-list (folder msgs)
 426   (let ((msg-list msgs)
 427         pair fld-list
 428         ret-val)
 429     (while msg-list
 430       (when (and (numberp (car msg-list))
 431                  (> (car msg-list) 0))
 432         (setq pair (elmo-get-real-folder-number folder (car msg-list)))
 433         (if (setq fld-list (assoc (car pair) ret-val))
 434             (setcdr fld-list (cons (cdr pair) (cdr fld-list)))
 435           (setq ret-val (cons (cons (car pair) (list (cdr pair))) ret-val))))
 436       (setq msg-list (cdr msg-list)))
 437     ret-val))
 438
 439 (defun elmo-call-func-on-markable-msgs (folder func-name msgs msgdb)
 440   "Returns t if marked."
 441   (save-match-data
 442     (let ((folder-numbers (elmo-make-folder-numbers-list folder msgs))
 443           type error)
 444       (while folder-numbers
 445         (if (or (eq
 446                  (setq type (car
 447                              (elmo-folder-get-spec
 448                               (car (car folder-numbers)))))
 449                  'imap4)
 450                 (memq type '(maildir internal)))
 451             (if (elmo-folder-plugged-p folder)
 452                 (elmo-call-func (car (car folder-numbers)) func-name
 453                                 (cdr (car folder-numbers)))
 454               (if elmo-enable-disconnected-operation
 455                   (elmo-dop-call-func-on-msgs
 456                    (car (car folder-numbers)) ; real folder
 457                    func-name
 458                    (cdr (car folder-numbers)) ; real number
 459                    msgdb)
 460                 (setq error t))))
 461         (setq folder-numbers (cdr folder-numbers)))
 462       (not error))))
 463
 464 (defun elmo-unmark-important (folder msgs msgdb)
 465   (elmo-call-func-on-markable-msgs folder "unmark-important" msgs msgdb))
 466
 467 (defun elmo-mark-as-important (folder msgs msgdb)
 468   (elmo-call-func-on-markable-msgs folder "mark-as-important" msgs msgdb))
 469
 470 (defun elmo-mark-as-read (folder msgs msgdb)
 471   (elmo-call-func-on-markable-msgs folder "mark-as-read" msgs msgdb))
 472
 473 (defun elmo-mark-as-unread (folder msgs msgdb)
 474   (elmo-call-func-on-markable-msgs folder "mark-as-unread" msgs msgdb))
 475
 476 (defun elmo-msgdb-create-as-numlist (folder numlist new-mark already-mark
 477                                             seen-mark important-mark seen-list)
 478   (if (elmo-folder-plugged-p folder)
 479       (elmo-call-func folder "msgdb-create-as-numlist" numlist
 480                       new-mark already-mark seen-mark important-mark seen-list)
 481     (elmo-dop-msgdb-create-as-numlist
 482      folder numlist new-mark already-mark
 483      seen-mark important-mark seen-list)))
 484
 485 ;;   msgdb elmo-msgdb-load        (folder)
 486 (defun elmo-msgdb-load (folder)
 487   (message "Loading msgdb for %s..." folder)
 488   (let* ((path (elmo-msgdb-expand-path folder))
 489          (overview (elmo-msgdb-overview-load path))
 490          (ret-val
 491           (list overview
 492                 (elmo-msgdb-number-load path)
 493                 (elmo-msgdb-mark-load path)
 494                 (elmo-msgdb-location-load path)
 495                 (elmo-msgdb-make-overview-hashtb overview)
 496                 )))
 497     (message "Loading msgdb for %s...done" folder)
 498     (elmo-folder-set-info-max-by-numdb folder (nth 1 ret-val))
 499     ret-val))
 500
 501 ;;   boolean elmo-msgdb-save (folder msgdb)
 502 (defun elmo-msgdb-save (folder msgdb)
 503   (message "Saving msgdb for %s..." folder)
 504   (save-excursion
 505     (let ((path (elmo-msgdb-expand-path folder)))
 506       (elmo-msgdb-overview-save path (car msgdb))
 507       (elmo-msgdb-number-save path (cadr msgdb))
 508       (elmo-msgdb-mark-save path (caddr msgdb))
 509       (elmo-msgdb-location-save path (cadddr msgdb))
 510     ;(elmo-sync-validity folder);; for validity check!!
 511       ))
 512   (message "Saving msgdb for %s...done" folder)
 513   (elmo-folder-set-info-max-by-numdb folder (cadr msgdb)))
 514
 515 (defun elmo-msgdb-add-msgs-to-seen-list-subr (msgs msgdb seen-marks seen-list)
 516   "Add to seen list."
 517   (let* ((seen-mark-list (string-to-char-list seen-marks))
 518          (number-alist (elmo-msgdb-get-number-alist msgdb))
 519          (mark-alist   (elmo-msgdb-get-mark-alist msgdb))
 520          ent)
 521     (while msgs
 522       (if (setq ent (assq (car msgs) mark-alist))
 523           (if (memq (string-to-char (cadr ent)) seen-mark-list)
 524               (setq seen-list
 525                     (cons (cdr (assq (car msgs) number-alist)) seen-list)))
 526         ;; no mark ... seen...
 527         (setq seen-list
 528               (cons (cdr (assq (car msgs) number-alist)) seen-list)))
 529       (setq msgs (cdr msgs)))
 530     seen-list))
 531
 532 (defun elmo-msgdb-add-msgs-to-seen-list (folder msgs msgdb seen-marks)
 533   "Add to seen list."
 534   (unless (eq folder 'null) ;; black hole
 535     (let* ((dir (elmo-msgdb-expand-path folder))
 536            (seen-list (elmo-msgdb-seen-load dir)))
 537       (setq seen-list
 538             (elmo-msgdb-add-msgs-to-seen-list-subr
 539              msgs msgdb seen-marks seen-list))
 540       (elmo-msgdb-seen-save dir seen-list))))
 541
 542 ;;  msgdb elmo-append-msg (folder string)
 543 (defun elmo-append-msg (folder string &optional message-id msg no-see)
 544   (let ((type (elmo-folder-get-type folder))
 545         filename)
 546     (cond ((eq type 'imap4)
 547            (if (elmo-folder-plugged-p folder)
 548                (elmo-call-func folder "append-msg" string msg no-see)
 549              (elmo-dop-append-msg folder string message-id)))
 550           ((eq type 'cache)
 551            (if message-id
 552                (elmo-cache-append-msg
 553                 (elmo-folder-get-spec folder)
 554                 string message-id msg no-see)
 555              (error "elmo-cache-append-msg require message-id")))
 556           (t
 557            (elmo-call-func folder "append-msg" string msg no-see)))))
 558
 559 (defun elmo-check-validity (folder)
 560   (elmo-call-func folder "check-validity"
 561                   (expand-file-name
 562                    elmo-msgdb-validity-filename
 563                    (elmo-msgdb-expand-path folder))))
 564
 565 (defun elmo-pack-number (folder msgdb arg)
 566   (let ((type (elmo-folder-get-type folder)))
 567     (if (memq type '(localdir localnews maildir))
 568         (elmo-call-func folder "pack-number" msgdb arg)
 569       (error "pack-number not supported"))))
 570
 571 (defun elmo-sync-validity (folder)
 572   (elmo-call-func folder "sync-validity"
 573                   (expand-file-name
 574                    elmo-msgdb-validity-filename
 575                    (elmo-msgdb-expand-path folder))))
 576
 577 (defun elmo-use-cache-p (folder number)
 578   (elmo-call-func folder "use-cache-p" number)
 579   )
 580
 581 (defun elmo-local-file-p (folder number)
 582   (elmo-call-func folder "local-file-p" number))
 583
 584 (defun elmo-folder-portinfo (folder)
 585   (condition-case nil
 586       (elmo-call-func folder "portinfo")
 587     (error)))
 588
 589 (defun elmo-folder-plugged-p (folder)
 590   (and folder
 591        (or (elmo-folder-local-p folder)
 592            (elmo-call-func folder "plugged-p"))))
 593
 594 (defun elmo-folder-set-plugged (folder plugged &optional add)
 595   (if (elmo-folder-local-p folder)
 596       nil       ;; nop
 597     (elmo-call-func folder "set-plugged" plugged add)))
 598
 599 (defun elmo-generic-sync-number-alist (spec number-alist)
 600   "Just return number-alist."
 601   number-alist)
 602
 603 (defun elmo-generic-list-folder-important (spec number-alist)
 604   nil)
 605
 606 (defun elmo-update-number (folder msgdb)
 607   (when (elmo-folder-plugged-p folder)
 608     (message "Synchronize number...")
 609     (let* ((numlist (elmo-msgdb-get-number-alist msgdb))
 610            (len (length numlist))
 611            new-numlist)
 612       (if (eq (length (setq
 613                        new-numlist
 614                        (elmo-call-func folder "sync-number-alist" numlist)))
 615               len)
 616           nil
 617         (elmo-msgdb-set-number-alist msgdb new-numlist)
 618         (message "Synchronize number...done")
 619         new-numlist))))
 620
 621 (defun elmo-get-msg-filename (folder number &optional loc-alist)
 622   "Available if elmo-local-file-p is t."
 623   (elmo-call-func folder "get-msg-filename" number loc-alist))
 624
 625 (defun elmo-strict-folder-diff (fld &optional number-alist)
 626   (interactive)
 627   (let* ((dir (elmo-msgdb-expand-path fld))
 628          (nalist (or number-alist
 629                      (elmo-msgdb-number-load dir)))
 630          (in-db (sort (mapcar 'car nalist) '<))
 631          (in-folder  (elmo-list-folder fld))
 632          append-list delete-list diff)
 633     (cons (if (equal in-folder in-db)
 634               0
 635             (setq diff (elmo-list-diff
 636                         in-folder in-db
 637                         nil
 638                         ))
 639             (setq append-list (car diff))
 640             (setq delete-list (cadr diff))
 641             (if append-list
 642                 (length append-list)
 643               (if delete-list
 644                   (- 0 (length delete-list))
 645                 0)))
 646           (length in-folder))))
 647
 648 (defun elmo-list-folder-unread (folder number-alist mark-alist unread-marks)
 649   (elmo-call-func folder "list-folder-unread"
 650                   number-alist mark-alist unread-marks))
 651
 652 (defun elmo-list-folder-important (folder number-alist)
 653   (let (importants)
 654     ;; Server side importants...(append only.)
 655     (if (elmo-folder-plugged-p folder)
 656         (setq importants (elmo-call-func folder "list-folder-important"
 657                                          number-alist)))
 658     (or elmo-msgdb-global-mark-alist
 659         (setq elmo-msgdb-global-mark-alist
 660               (elmo-object-load (expand-file-name
 661                                  elmo-msgdb-global-mark-filename
 662                                  elmo-msgdb-dir))))
 663     (while number-alist
 664       (if (assoc (cdr (car number-alist))
 665                  elmo-msgdb-global-mark-alist)
 666           (setq importants (cons (car (car number-alist)) importants)))
 667       (setq number-alist (cdr number-alist)))
 668     importants))
 669
 670 (defun elmo-generic-commit (folder)
 671   nil)
 672
 673 (defun elmo-commit (folder)
 674   (elmo-call-func folder "commit"))
 675
 676 (defun elmo-clear-killed (folder)
 677   (elmo-msgdb-killed-list-save (elmo-msgdb-expand-path folder) nil))
 678
 679 (defvar elmo-folder-diff-async-callback nil)
 680 (defvar elmo-folder-diff-async-callback-data nil)
 681
 682 (defun elmo-folder-diff-async (folder)
 683   "Get diff of FOLDER asynchronously.
 684 `elmo-folder-diff-async-callback' is called with arguments of
 685 FOLDER and DIFF (cons cell of UNSEEN and MESSAGES).
 686 Currently works on IMAP4 folder only."
 687   (if (eq (elmo-folder-get-type folder) 'imap4)
 688       ;; Only works on imap4 with server diff.
 689       (progn
 690         (setq elmo-imap4-server-diff-async-callback
 691               elmo-folder-diff-async-callback)
 692         (setq elmo-imap4-server-diff-async-callback-data
 693               elmo-folder-diff-async-callback-data)
 694         (elmo-imap4-server-diff-async (elmo-folder-get-spec folder)))
 695     (and elmo-folder-diff-async-callback
 696          (funcall elmo-folder-diff-async-callback
 697                   folder
 698                   (elmo-folder-diff folder)))))
 699
 700 (defun elmo-folder-diff (folder &optional number-list)
 701   "Get diff of FOLDER.
 702 Return value is a cons cell of NEW and MESSAGES.
 703 If optional argumnet NUMBER-LIST is set, it is used as a
 704 message list in msgdb. Otherwise, number-list is load from msgdb."
 705   (elmo-call-func folder "folder-diff" folder number-list))
 706
 707 (defun elmo-crosspost-message-set (message-id folders &optional type)
 708   (if (assoc message-id elmo-crosspost-message-alist)
 709       (setcdr (assoc message-id elmo-crosspost-message-alist)
 710               (list folders type))
 711     (setq elmo-crosspost-message-alist
 712           (nconc elmo-crosspost-message-alist
 713                  (list (list message-id folders type))))))
 714
 715 (defun elmo-crosspost-message-delete (message-id folders)
 716   (let* ((id-fld (assoc message-id elmo-crosspost-message-alist))
 717          (folder-list (nth 1 id-fld)))
 718     (when id-fld
 719       (if (setq folder-list (elmo-list-delete folders folder-list))
 720           (setcar (cdr id-fld) folder-list)
 721         (setq elmo-crosspost-message-alist
 722               (delete id-fld elmo-crosspost-message-alist))))))
 723
 724
 725 (defun elmo-get-msgs-with-mark (mark-alist mark)
 726   (let (ret-val)
 727     (while mark-alist
 728       (if (string= (cadr (car mark-alist)) mark)
 729           (cons (car (car mark-alist)) ret-val))
 730       (setq mark-alist (cdr mark-alist)))
 731     (nreverse ret-val)))
 732
 733 (defun elmo-buffer-cache-message (fld msg &optional msgdb force-reload)
 734   (let* ((msg-id (cdr (assq msg (elmo-msgdb-get-number-alist msgdb))))
 735          (hit (elmo-buffer-cache-hit (list fld msg msg-id)))
 736          (read nil))
 737     (if hit
 738         (elmo-buffer-cache-sort
 739          (elmo-buffer-cache-entry-make (list fld msg msg-id) hit))
 740       (setq hit (elmo-buffer-cache-add (list fld msg msg-id)))
 741       (setq read t))
 742     (if (or force-reload read)
 743         (condition-case err
 744             (save-excursion
 745               (set-buffer hit)
 746               (elmo-read-msg fld msg
 747                              (current-buffer)
 748                              msgdb force-reload))
 749           (quit
 750            (elmo-buffer-cache-delete)
 751            (error "read message %s/%s is quitted" fld msg))
 752           (error
 753            (elmo-buffer-cache-delete)
 754            (signal (car err) (cdr err))
 755            nil))) ;; will not be used
 756     hit)) ;; retrun value
 757
 758 (defun elmo-read-msg-with-buffer-cache (fld msg outbuf msgdb &optional force-reload)
 759   (if elmo-use-buffer-cache
 760       (let (hit start end)
 761         (when (setq hit (elmo-buffer-cache-message
 762                          (elmo-string fld) msg
 763                          msgdb force-reload))
 764           (erase-buffer)
 765           (save-excursion
 766             (set-buffer hit)
 767             (setq start (point-min) end (point-max)))
 768           (insert-buffer-substring hit start end)))
 769     (elmo-read-msg fld msg outbuf msgdb force-reload)))
 770
 771 (defun elmo-folder-pipe-p (folder)
 772   (let ((type (elmo-folder-get-type folder)))
 773     (cond
 774      ((eq type 'multi)
 775       (let ((flds (cdr (elmo-folder-get-spec folder))))
 776         (catch 'done
 777           (while flds
 778             (if (elmo-folder-pipe-p (car flds))
 779                 (throw 'done t)))
 780           nil)))
 781      ((eq type 'pipe)
 782       t)
 783      ((eq type 'filter)
 784       (elmo-folder-pipe-p
 785        (nth 2 (elmo-folder-get-spec folder))))
 786      (t
 787       nil
 788       ))))
 789
 790 (defun elmo-multi-p (folder)
 791   (let ((type (elmo-folder-get-type folder)))
 792     (cond
 793      ((eq type 'multi)
 794       t)
 795      ((eq type 'pipe)
 796       (elmo-multi-p
 797        (elmo-pipe-spec-dst (elmo-folder-get-spec folder))))
 798      ((eq type 'filter)
 799       (elmo-multi-p
 800        (nth 2 (elmo-folder-get-spec folder))))
 801      (t
 802       nil
 803       ))))
 804
 805 (defun elmo-get-real-folder-number (folder number)
 806   (let ((type (elmo-folder-get-type folder)))
 807     (cond
 808      ((eq type 'multi)
 809       (elmo-multi-get-real-folder-number folder number))
 810      ((eq type 'pipe)
 811       (elmo-get-real-folder-number
 812        (elmo-pipe-spec-dst (elmo-folder-get-spec folder) )
 813        number))
 814      ((eq type 'filter)
 815       (elmo-get-real-folder-number
 816        (nth 2 (elmo-folder-get-spec folder)) number))
 817      (t
 818       (cons folder number)
 819       ))))
 820
 821 (defun elmo-folder-get-primitive-spec-list (folder &optional spec-list)
 822   (let ((type (elmo-folder-get-type folder))
 823         specs)
 824     (cond
 825      ((or (eq type 'multi)
 826           (eq type 'pipe))
 827       (let ((flds (cdr (elmo-folder-get-spec folder)))
 828             spec)
 829         (while flds
 830           (setq spec (elmo-folder-get-primitive-spec-list (car flds)))
 831           (if (not (memq (car spec) specs))
 832               (setq specs (append specs spec)))
 833           (setq flds (cdr flds)))))
 834      ((eq type 'filter)
 835       (setq specs
 836             (elmo-folder-get-primitive-spec-list
 837              (nth 2 (elmo-folder-get-spec folder)))))
 838      (t
 839       (setq specs (list (elmo-folder-get-spec folder)))
 840       ))
 841     specs))
 842
 843 (defun elmo-folder-get-primitive-folder-list (folder)
 844   (let* ((type (elmo-folder-get-type folder)))
 845     (cond
 846      ((or (eq type 'multi)
 847           (eq type 'pipe))
 848       (let ((flds (cdr (elmo-folder-get-spec folder)))
 849             ret-val)
 850         (while flds
 851           (setq ret-val (append ret-val
 852                                 (elmo-folder-get-primitive-folder-list
 853                                  (car flds))))
 854           (setq flds (cdr flds)))
 855         ret-val))
 856      ((eq type 'filter)
 857       (elmo-folder-get-primitive-folder-list
 858        (nth 2 (elmo-folder-get-spec folder))))
 859      (t
 860       (list folder)
 861       ))))
 862
 863 (defun elmo-folder-contains-multi (folder)
 864   (let ((cur-spec (elmo-folder-get-spec folder)))
 865     (catch 'done
 866       (while cur-spec
 867         (cond
 868          ((eq (car cur-spec) 'filter)
 869           (setq cur-spec (elmo-folder-get-spec (nth 2 cur-spec))))
 870          ((eq (car cur-spec) 'pipe)
 871           (setq cur-spec (elmo-folder-get-spec (elmo-pipe-spec-src cur-spec))))
 872          ((eq (car cur-spec) 'multi)
 873           (throw 'done nil))
 874          (t (setq cur-spec nil)))))
 875     cur-spec))
 876
 877 (defun elmo-folder-contains-type (folder type)
 878   (let ((spec (elmo-folder-get-spec folder)))
 879     (cond
 880      ((eq (car spec) 'filter)
 881       (elmo-folder-contains-type (nth 2 spec) type))
 882      ((eq (car spec) 'pipe)
 883       (elmo-folder-contains-type (elmo-pipe-spec-dst spec) type))
 884      ((eq (car spec) 'multi)
 885       (let ((folders (cdr spec)))
 886         (catch 'done
 887           (while folders
 888             (if (elmo-folder-contains-type (car folders) type)
 889                 (throw 'done t))
 890             (setq folders (cdr folders))))))
 891      ((eq (car spec) type)
 892       t)
 893      (t nil))))
 894
 895 (defun elmo-folder-number-get-spec (folder number)
 896   (let ((type (elmo-folder-get-type folder)))
 897     (cond
 898      ((eq type 'multi)
 899       (elmo-multi-folder-number-get-spec folder number))
 900      ((eq type 'pipe)
 901       (elmo-folder-number-get-spec
 902        (elmo-pipe-spec-dst (elmo-folder-get-spec folder)) number))
 903      ((eq type 'filter)
 904       (elmo-folder-number-get-spec
 905        (nth 2 (elmo-folder-get-spec folder)) number))
 906      (t
 907       (elmo-folder-get-spec folder)
 908       ))))
 909
 910 (defun elmo-folder-number-get-type (folder number)
 911   (car (elmo-folder-number-get-spec folder number)))
 912
 913 (defun elmo-multi-folder-number-get-spec (folder number)
 914   (let* ((spec (elmo-folder-get-spec folder))
 915          (flds (cdr spec))
 916          (fld (nth (- (/ number elmo-multi-divide-number) 1) flds)))
 917     (elmo-folder-number-get-spec fld number)))
 918
 919 ;; autoloads
 920 (autoload 'elmo-nntp-make-groups-hashtb "elmo-nntp")
 921 (autoload 'elmo-nntp-post "elmo-nntp")
 922 (autoload 'elmo-localdir-max-of-folder "elmo-localdir")
 923 (autoload 'elmo-localdir-msgdb-create-overview-entity-from-file "elmo-localdir")
 924 (autoload 'elmo-archive-copy-msgs-froms "elmo-archive")
 925
 926 (require 'product)
 927 (product-provide (provide 'elmo2) (require 'elmo-version))
 928
 929 ;;; elmo2.el ends here