* elmo.el (elmo-folder-list-unreads): Don't use msgdb API.
[elisp/wanderlust.git] / elmo / elmo.el
index ad62248..a4e4793 100644 (file)
@@ -140,25 +140,26 @@ If optional argument NON-PERSISTENT is non-nil, the folder msgdb is not saved."
     (setq class (format "elmo-%s" (symbol-name type)))
     (require (intern class))
     (setq folder (luna-make-entity (intern (concat class "-folder"))
-                                  :type   type
+                                  :type type
                                   :prefix prefix
                                   :name original
                                   :persistent (not non-persistent)))
     (save-match-data
       (elmo-folder-send folder 'elmo-folder-initialize name))))
 
+;; Note that this function is for internal use only.
 (luna-define-generic elmo-folder-msgdb (folder)
-  "Return the msgdb of FOLDER (on-demand loading).")
+  "Return the msgdb of FOLDER (on-demand loading).
+\(For internal use only.\)")
 
 (luna-define-method elmo-folder-msgdb ((folder elmo-folder))
   (or (elmo-folder-msgdb-internal folder)
       (elmo-folder-set-msgdb-internal folder
                                      (elmo-msgdb-load folder))))
-
 (luna-define-generic elmo-folder-open (folder &optional load-msgdb)
   "Open and setup (load saved status) FOLDER.
 If optional LOAD-MSGDB is non-nil, msgdb is loaded.
-(otherwise, msgdb is loaded on-demand)")
+\(otherwise, msgdb is loaded on-demand)")
 
 (luna-define-generic elmo-folder-open-internal (folder)
   "Open FOLDER (without loading saved folder status).")
@@ -196,8 +197,8 @@ If optional KEEP-KILLED is non-nil, killed-list is not cleared.")
 If optional NUMBERS is set, it is used as current NUMBERS.
 Otherwise, saved status for folder is used for comparison.
 Return value is cons cell or list:
- - a cons cell (NEWS . MESSAGES)
- - a list (RECENT UNSEEN MESSAGES) ; RECENT means NEWS, UNSEEN means UNREAD.")
+ - a cons cell (new . all)
+ - a list (new unread all)")
 
 (luna-define-generic elmo-folder-status (folder)
   "Returns a cons cell of (MAX-NUMBER . MESSAGES) in the FOLDER.")
@@ -205,10 +206,13 @@ Return value is cons cell or list:
 (luna-define-generic elmo-folder-reserve-status-p (folder)
   "If non-nil, the folder should not close folder after `elmo-folder-status'.")
 
-(defun elmo-folder-list-messages (folder &optional visible-only in-msgdb)
+(luna-define-generic elmo-folder-list-messages (folder &optional visible-only
+                                                      in-msgdb)
   "Return a list of message numbers contained in FOLDER.
 If optional VISIBLE-ONLY is non-nil, killed messages are not listed.
-If second optional IN-MSGDB is non-nil, only messages in the msgdb are listed."
+If second optional IN-MSGDB is non-nil, only messages in the msgdb are listed.")
+(luna-define-method elmo-folder-list-messages ((folder elmo-folder)
+                                              &optional visible-only in-msgdb)
   (let ((list (if in-msgdb
                  t
                (elmo-folder-list-messages-internal folder visible-only))))
@@ -216,9 +220,7 @@ If second optional IN-MSGDB is non-nil, only messages in the msgdb are listed."
      (if (listp list)
         list
        ;; Use current list.
-       (mapcar
-       'car
-       (elmo-msgdb-get-number-alist (elmo-folder-msgdb folder))))
+       (elmo-msgdb-list-messages (elmo-folder-msgdb folder)))
      (elmo-folder-killed-list-internal folder))))
 
 (luna-define-generic elmo-folder-list-unreads (folder)
@@ -266,13 +268,13 @@ If optional IN-MSGDB is non-nil, retrieve flag information from msgdb.")
   (elmo-msgdb-list-flagged (elmo-folder-msgdb folder) flag))
 
 (luna-define-method elmo-folder-list-unreads ((folder elmo-folder))
-  (elmo-msgdb-list-flagged (elmo-folder-msgdb folder) 'unread))
+  (elmo-folder-list-flagged folder 'unread))
 
 (luna-define-method elmo-folder-list-importants ((folder elmo-folder))
-  (elmo-msgdb-list-flagged (elmo-folder-msgdb folder) 'important))
+  (elmo-folder-list-flagged folder 'important))
 
 (luna-define-method elmo-folder-list-answereds ((folder elmo-folder))
-  (elmo-msgdb-list-flagged (elmo-folder-msgdb folder) 'answered))
+  (elmo-folder-list-flagged folder 'answered))
 
 (luna-define-generic elmo-folder-list-messages-internal (folder &optional
                                                                visible-only)
@@ -333,21 +335,27 @@ CONDITION is a condition structure for testing.
 NUMBERS is a list of message numbers,
 use to be test for \"last\" and \"first\" predicates.")
 
-(luna-define-generic elmo-folder-msgdb-create (folder numbers id-mark-table)
+(luna-define-generic elmo-folder-msgdb-create (folder numbers flag-table)
   "Create a message database (implemented in each backends).
 FOLDER is the ELMO folder structure.
 NUMBERS is a list of message numbers to create msgdb.
-ID-MARK-TABLE is a hashtable of message-id and its status mark.")
+FLAG-TABLE is a hashtable of message-id and flag.")
 
-(luna-define-generic elmo-folder-unmark-important (folder numbers)
+(luna-define-generic elmo-folder-unmark-important (folder
+                                                  numbers
+                                                  &optional ignore-flags)
   "Un-mark messages as important.
 FOLDER is the ELMO folder structure.
-NUMBERS is a list of message numbers to be processed.")
+NUMBERS is a list of message numbers to be processed.
+If IGNORE-FLAGS is non-nil, folder flags are not updated.")
 
-(luna-define-generic elmo-folder-mark-as-important (folder numbers)
+(luna-define-generic elmo-folder-mark-as-important (folder 
+                                                   numbers
+                                                   &optional ignore-flags)
   "Mark messages as important.
 FOLDER is the ELMO folder structure.
-NUMBERS is a list of message numbers to be processed.")
+NUMBERS is a list of message numbers to be processed.
+If IGNORE-FLAGS is non-nil, folder flags are not updated.")
 
 (luna-define-generic elmo-folder-unmark-read (folder numbers
                                                     &optional ignore-flags)
@@ -373,10 +381,11 @@ NUMBERS is a list of message numbers to be processed.")
 FOLDER is the ELMO folder structure.
 NUMBERS is a list of message numbers to be processed.")
 
-(luna-define-generic elmo-folder-append-buffer (folder unread &optional number)
+(luna-define-generic elmo-folder-append-buffer (folder &optional flag
+                                                      number)
   "Append current buffer as a new message.
 FOLDER is the destination folder(ELMO folder structure).
-If UNREAD is non-nil, message is appended as unread.
+FLAG is the status of appended message.
 If optional argument NUMBER is specified, the new message number is set
 \(if possible\).")
 
@@ -609,9 +618,7 @@ FIELD is a symbol of the field name.")
 (luna-define-generic elmo-message-folder (folder number)
   "Get primitive folder of the message.")
 
-(luna-define-generic elmo-folder-process-crosspost (folder
-                                                   &optional
-                                                   number-alist)
+(luna-define-generic elmo-folder-process-crosspost (folder)
   "Process crosspost for FOLDER.
 If NUMBER-ALIST is set, it is used as number-alist.
 Return a cons cell of (NUMBER-CROSSPOSTS . NEW-MARK-ALIST).")
@@ -719,7 +726,10 @@ Return a cons cell of (NUMBER-CROSSPOSTS . NEW-MARK-ALIST).")
   nil) ; default is not writable.
 
 (luna-define-method elmo-folder-delete ((folder elmo-folder))
-  (elmo-msgdb-delete-path folder))
+  (when (yes-or-no-p (format "Delete msgdb of \"%s\"? "
+                            (elmo-folder-name-internal folder)))
+    (elmo-msgdb-delete-path folder)
+    t))
 
 (luna-define-method elmo-folder-rename ((folder elmo-folder) new-name)
   (let* ((new-folder (elmo-make-folder new-name)))
@@ -995,11 +1005,21 @@ Return a cons cell of (NUMBER-CROSSPOSTS . NEW-MARK-ALIST).")
 
 (defun elmo-generic-folder-append-messages (folder src-folder numbers
                                                   same-number)
-  (let (unseen seen-list succeed-numbers failure cache)
+  (let (unseen table flag mark
+              succeed-numbers failure cache)
+    (setq table (elmo-flag-table-load (elmo-folder-msgdb-path folder)))
     (with-temp-buffer
       (set-buffer-multibyte nil)
       (while numbers
-       (setq failure nil)
+       (setq failure nil
+             mark (elmo-message-mark src-folder (car numbers))
+             flag (cond
+                   ((null mark) nil)
+                   ((member mark (elmo-msgdb-answered-marks))
+                    'answered)
+                   ;;
+                   ((not (member mark (elmo-msgdb-unread-marks)))
+                    'read)))
        (condition-case nil
            (setq cache (elmo-file-cache-get
                         (elmo-message-field src-folder
@@ -1026,26 +1046,22 @@ Return a cons cell of (NUMBER-CROSSPOSTS . NEW-MARK-ALIST).")
                    (> (buffer-size) 0)
                    (elmo-folder-append-buffer
                     folder
-                    (setq unseen (member (elmo-message-mark
-                                          src-folder (car numbers))
-                                         (elmo-msgdb-unread-marks)))
+                    flag
                     (if same-number (car numbers))))))
          (error (setq failure t)))
        ;; FETCH & APPEND finished
        (unless failure
-         (unless unseen
-           (setq seen-list (cons (elmo-message-field
-                                  src-folder (car numbers)
-                                  'message-id)
-                                 seen-list)))
+         (when flag
+           (elmo-flag-table-set table
+                                (elmo-message-field
+                                 src-folder (car numbers)
+                                 'message-id)
+                                flag))
          (setq succeed-numbers (cons (car numbers) succeed-numbers)))
        (elmo-progress-notify 'elmo-folder-move-messages)
        (setq numbers (cdr numbers)))
-      (if (and seen-list (elmo-folder-persistent-p folder))
-         (elmo-msgdb-seen-save (elmo-folder-msgdb-path folder)
-                               (nconc (elmo-msgdb-seen-load
-                                       (elmo-folder-msgdb-path folder))
-                                      seen-list)))
+      (when (elmo-folder-persistent-p folder)
+       (elmo-flag-table-save (elmo-folder-msgdb-path folder) table))
       succeed-numbers)))
 
 ;; Arguments should be reduced.
@@ -1074,35 +1090,19 @@ Return a cons cell of (NUMBER-CROSSPOSTS . NEW-MARK-ALIST).")
                                                              same-number))
            (error "move: append message to %s failed"
                   (elmo-folder-name-internal dst-folder)))
-         (elmo-folder-close dst-folder))
-       (when (and (elmo-folder-persistent-p dst-folder)
-                  save-unread)
-         ;; Save to seen list.
-         (let* ((dir (elmo-folder-msgdb-path dst-folder))
-                (seen-list (elmo-msgdb-seen-load dir)))
-           (setq seen-list
-                 (elmo-msgdb-add-msgs-to-seen-list
-                  msgs (elmo-folder-msgdb src-folder)
-                  seen-list))
-           (elmo-msgdb-seen-save dir seen-list))))
+         (elmo-folder-close dst-folder)))
       (if (and (not no-delete) succeeds)
          (progn
-           (if (not no-delete-info)
-               (message "Cleaning up src folder..."))
            (if (and (elmo-folder-delete-messages src-folder succeeds)
-                    (elmo-msgdb-delete-msgs
-                     (elmo-folder-msgdb src-folder) succeeds))
+                    (elmo-folder-detach-messages src-folder succeeds))
                (setq result t)
              (message "move: delete messages from %s failed."
                       (elmo-folder-name-internal src-folder))
              (setq result nil))
-           (if (and result
-                    (not no-delete-info))
-               (message "Cleaning up src folder...done"))
            result)
        (if no-delete
            (progn
-             (message "Copying messages...done")
+             ;; (message "Copying messages...done")
              t)
          (if (eq len 0)
              (message "No message was moved.")
@@ -1135,6 +1135,82 @@ If CACHED is t, message is set as cached."
                               (elmo-message-use-cache-p folder number))
     (elmo-folder-set-mark-modified-internal folder t)))
 
+(defun elmo-message-copy-entity (entity)
+  ;; 
+  (elmo-msgdb-copy-overview-entity entity))
+
+(defun elmo-message-entity-set-number (entity number)  
+  (elmo-msgdb-overview-entity-set-number entity number))
+
+(luna-define-generic elmo-message-entity (folder key)
+  "Return the message-entity structure which matches to the KEY.
+KEY is a number or a string.
+A number is for message number in the FOLDER.
+A string is for message-d of the message.")
+
+(luna-define-method elmo-message-entity ((folder elmo-folder) key)
+  (elmo-msgdb-message-entity (elmo-folder-msgdb folder) key))
+
+(luna-define-generic elmo-message-entity-parent (folder entity)
+  "Return the parent message-entity structure in the FOLDER.
+ENTITY is the message-entity to get the parent.")
+
+(luna-define-method elmo-message-entity-parent ((folder elmo-folder) entity)
+  (elmo-msgdb-get-parent-entity entity (elmo-folder-msgdb folder)))
+
+(put 'elmo-folder-do-each-message-entity 'lisp-indent-function '1)
+(def-edebug-spec elmo-folder-do-each-message-entity
+  ((symbolp form &rest form) &rest form))
+
+(defsubst elmo-folder-list-message-entities (folder)
+  ;; List all message entities in the FOLDER.
+  (mapcar
+   (lambda (number) (elmo-message-entity folder number))
+   (elmo-folder-list-messages folder t t)))
+
+(defmacro elmo-folder-do-each-message-entity (spec &rest form)
+  "Iterator for message entity in the folder.
+\(elmo-folder-do-each-message-entity \(entity folder\)
+ ... do the process using entity...
+\)"
+  `(dolist (,(car spec) (elmo-folder-list-message-entities ,(car (cdr spec))))
+     ,@form))
+
+(defmacro elmo-message-entity-number (entity)
+  `(elmo-msgdb-overview-entity-get-number ,entity))
+
+(defun elmo-message-entity-field (entity field &optional decode)
+  "Get message entity field value.
+ENTITY is the message entity structure obtained by `elmo-message-entity'.
+FIELD is the symbol of the field name.
+if optional DECODE is non-nil, returned value is decoded."
+  (elmo-msgdb-message-entity-field entity field decode))
+
+(defun elmo-message-entity-set-field (entity field value)
+  "Set message entity field value.
+ENTITY is the message entity structure.
+FIELD is the symbol of the field name.
+VALUE is the field value (raw)."
+  (elmo-msgdb-message-entity-set-field entity field value))
+
+(luna-define-generic elmo-folder-count-flags (folder)
+  "Count flagged message number in the msgdb of the FOLDER.
+Return a list of numbers (`new' `unread' `answered')")
+
+(luna-define-method elmo-folder-count-flags ((folder elmo-folder))
+  (let ((new 0)
+       (unreads 0)
+       (answered 0))
+    (dolist (elem (elmo-msgdb-get-mark-alist (elmo-folder-msgdb folder)))
+      (cond
+       ((string= (cadr elem) elmo-msgdb-new-mark)
+       (incf new))
+       ((member (cadr elem) (elmo-msgdb-unread-marks))
+       (incf unreads))
+       ((member (cadr elem) (elmo-msgdb-answered-marks))
+       (incf answered))))
+    (list new unreads answered)))
+
 (defun elmo-message-set-flag (folder number flag)
   "Set message flag.
 FOLDER is a ELMO folder structure.
@@ -1159,10 +1235,12 @@ FLAG is a symbol which is one of the following:
 'sugar' flag:
   `read'      (set unread flag)")
 
-(defun elmo-message-mark (folder number)
+(luna-define-generic elmo-message-mark (folder number)
   "Get mark of the message.
 FOLDER is the ELMO folder structure.
-NUMBER is a number of the message."
+NUMBER is a number of the message.")
+
+(luna-define-method elmo-message-mark ((folder elmo-folder) number)
   (elmo-msgdb-get-mark (elmo-folder-msgdb folder) number))
 
 (defun elmo-message-field (folder number field)
@@ -1172,12 +1250,6 @@ NUMBER is a number of the message.
 FIELD is a symbol of the field."
   (elmo-msgdb-get-field (elmo-folder-msgdb folder) number field))
 
-(defun elmo-message-set-mark (folder number mark)
-  ;; Set mark for the message in the FOLDER with NUMBER as MARK.
-  (elmo-msgdb-set-mark
-   (elmo-folder-msgdb folder)
-   number mark))
-
 (luna-define-method elmo-message-use-cache-p ((folder elmo-folder) number)
   nil) ; default is not use cache.
 
@@ -1185,7 +1257,8 @@ FIELD is a symbol of the field."
   folder) ; default is folder
 
 (luna-define-method elmo-folder-unmark-important ((folder elmo-folder)
-                                                 numbers)
+                                                 numbers
+                                                 &optional ignore-flags)
   (when (elmo-folder-msgdb-internal folder)
     (dolist (number numbers)
       (elmo-msgdb-unset-flag (elmo-folder-msgdb folder)
@@ -1194,7 +1267,8 @@ FIELD is a symbol of the field."
                             'important))))
 
 (luna-define-method elmo-folder-mark-as-important ((folder elmo-folder)
-                                                  numbers)
+                                                  numbers
+                                                  &optional ignore-flags)
   (when (elmo-folder-msgdb-internal folder)
     (dolist (number numbers)
       (elmo-msgdb-set-flag (elmo-folder-msgdb folder)
@@ -1238,12 +1312,15 @@ FIELD is a symbol of the field."
                           number
                           'answered))))
 
-(luna-define-method elmo-folder-process-crosspost ((folder elmo-folder)
-                                                  &optional
-                                                  number-alist)
+(luna-define-method elmo-folder-process-crosspost ((folder elmo-folder))
   ;; Do nothing.
   )
 
+;;(luna-define-generic elmo-folder-append-message-entity (folder entity
+;;                                                            &optional
+;;                                                            flag-table)
+;;  "Append ENTITY to the folder.")
+
 (defun elmo-generic-folder-append-msgdb (folder append-msgdb)
   (if append-msgdb
       (let* ((number-alist (elmo-msgdb-get-number-alist append-msgdb))
@@ -1375,37 +1452,33 @@ FIELD is a symbol of the field."
     (elmo-folder-set-killed-list-internal folder nil))
   (elmo-folder-set-msgdb-internal folder (elmo-msgdb-clear)))
 
-(defun elmo-folder-synchronize (folder
-                               &optional ignore-msgdb
-                               no-check)
+(luna-define-generic elmo-folder-synchronize (folder
+                                             &optional ignore-msgdb
+                                             no-check)
   "Synchronize the folder data to the newest status.
 FOLDER is the ELMO folder structure.
+
 If optional IGNORE-MSGDB is non-nil, current msgdb is thrown away except
 flag status. If IGNORE-MSGDB is 'visible-only, only visible messages
 \(the messages which are not in the killed-list\) are thrown away and
 synchronized.
 If NO-CHECK is non-nil, rechecking folder is skipped.
-
 Return a list of a cross-posted message number.
-If update process is interrupted, return nil."
+If update process is interrupted, return nil.")
+                                             
+(luna-define-method elmo-folder-synchronize ((folder elmo-folder)
+                                            &optional ignore-msgdb no-check)
   (let ((killed-list (elmo-folder-killed-list-internal folder))
        (before-append t)
-       number-alist mark-alist
+       number-alist
        old-msgdb diff diff-2 delete-list new-list new-msgdb mark
-       seen-list crossed after-append)
+       flag-table crossed after-append numbers)
     (setq old-msgdb (elmo-folder-msgdb folder))
-    ;; Load seen-list.
-    (setq seen-list (elmo-msgdb-seen-load (elmo-folder-msgdb-path folder)))
-    (setq number-alist (elmo-msgdb-get-number-alist
-                       (elmo-folder-msgdb folder)))
-    (setq mark-alist (elmo-msgdb-get-mark-alist
-                     (elmo-folder-msgdb folder)))
-    (if ignore-msgdb
-       (progn
-         (setq seen-list (nconc (elmo-msgdb-seen-list
-                                 (elmo-folder-msgdb folder))
-                                seen-list))
-         (elmo-folder-clear folder (eq ignore-msgdb 'visible-only))))
+    (setq flag-table (elmo-flag-table-load (elmo-folder-msgdb-path folder)))
+    (when ignore-msgdb
+      (elmo-msgdb-flag-table (elmo-folder-msgdb folder) flag-table)
+      (elmo-folder-clear folder (eq ignore-msgdb 'visible-only)))
+    (setq numbers (sort (elmo-folder-list-messages folder nil t) '<))
     (unless no-check (elmo-folder-check folder))
     (condition-case nil
        (progn
@@ -1415,11 +1488,7 @@ If update process is interrupted, return nil."
          (setq diff (elmo-list-diff (elmo-folder-list-messages
                                      folder
                                      (eq 'visible-only ignore-msgdb))
-                                    (unless ignore-msgdb
-                                      (sort (mapcar
-                                             'car
-                                             number-alist)
-                                            '<))))
+                                    numbers))
          (message "Checking folder diff...done")
          (setq new-list (elmo-folder-confirm-appends (car diff)))
          ;; Set killed list.
@@ -1437,18 +1506,18 @@ If update process is interrupted, return nil."
                (elmo-folder-process-crosspost folder)
                0 ; no updates.
                )
-           (if delete-list (elmo-msgdb-delete-msgs
-                            (elmo-folder-msgdb folder) delete-list))
+           (when delete-list
+             (elmo-folder-detach-messages folder delete-list))
            (when new-list
-             (setq new-msgdb (elmo-folder-msgdb-create
-                              folder new-list seen-list))
              (elmo-msgdb-change-mark (elmo-folder-msgdb folder)
                                      elmo-msgdb-new-mark
                                      elmo-msgdb-unread-uncached-mark)
-             ;; Clear seen-list.
+             (setq new-msgdb (elmo-folder-msgdb-create
+                              folder new-list flag-table))
+             ;; Clear flag-table
              (if (elmo-folder-persistent-p folder)
-                 (setq seen-list (elmo-msgdb-seen-save
-                                  (elmo-folder-msgdb-path folder) nil)))
+                 (elmo-flag-table-save (elmo-folder-msgdb-path folder)
+                                       nil))
              (setq before-append nil)
              (setq crossed (elmo-folder-append-msgdb folder new-msgdb))
              ;; process crosspost.
@@ -1460,16 +1529,22 @@ If update process is interrupted, return nil."
            (or crossed 0)))
       (quit
        ;; Resume to the original status.
-       (if before-append
-          (elmo-folder-set-msgdb-internal folder old-msgdb))
+       (if before-append (elmo-folder-set-msgdb-internal folder old-msgdb))
        (elmo-folder-set-killed-list-internal folder killed-list)
        nil))))
 
-(defun elmo-folder-messages (folder)
-  "Return number of messages in the FOLDER."
-  (length
-   (elmo-msgdb-get-number-alist
-    (elmo-folder-msgdb folder))))
+(luna-define-generic elmo-folder-detach-messages (folder numbers)
+  "Remove messages with NUMBERS from MSGDB.")
+
+(luna-define-method elmo-folder-detach-messages ((folder elmo-folder)
+                                                numbers)
+  (elmo-msgdb-delete-msgs (elmo-folder-msgdb folder) numbers))
+
+(luna-define-generic elmo-folder-length (folder)
+  "Return number of messages in the FOLDER.")
+
+(luna-define-method elmo-folder-length ((folder elmo-folder))
+  (elmo-msgdb-length (elmo-folder-msgdb folder)))
 
 (defun elmo-msgdb-load (folder &optional silent)
   (unless silent
@@ -1569,6 +1644,11 @@ Return a hashtable for newsgroups."
            (funcall func nil)))
       (setq types (cdr types)))))
 
+(luna-define-method elmo-folder-rename-internal ((folder elmo-folder)
+                                                new-folder)
+  (error "Cannot rename %s folder"
+        (symbol-name (elmo-folder-type-internal folder))))
+
 
 ;;; Define folders.
 (elmo-define-folder ?% 'imap4)