INSTALL, INSTALL.ja: Write about WL-CFG.
[elisp/wanderlust.git] / elmo / elmo-shimbun.el
index 707f317..f290028 100644 (file)
@@ -1,4 +1,4 @@
-;;; elmo-shimbun.el -- Shimbun interface for ELMO.
+;;; elmo-shimbun.el --- Shimbun interface for ELMO.
 
 ;; Copyright (C) 2001 Yuuichi Teranishi <teranisi@gohome.org>
 
@@ -33,6 +33,9 @@
 (require 'elmo-dop)
 (require 'shimbun)
 
+(eval-when-compile
+  (defun-maybe shimbun-servers-list ()))
+
 (defcustom elmo-shimbun-check-interval 60
   "*Check interval for shimbun."
   :type 'integer
@@ -61,6 +64,28 @@ See `shimbun-headers' for more detail about RANGE."
                               (integer :tag "number"))))
   :group 'elmo)
 
+(defcustom elmo-shimbun-update-overview-folder-list nil
+  "*List of FOLDER-REGEXP.
+FOLDER-REGEXP is the regexp of shimbun folder name which should be
+update overview when message is fetched."
+  :type '(repeat (regexp :tag "Folder Regexp"))
+  :group 'elmo)
+
+;; Shimbun header.
+(defsubst elmo-shimbun-header-extra-field (header field-name)
+  (let ((extra (and header (shimbun-header-extra header))))
+    (and extra
+        (cdr (assoc field-name extra)))))
+
+(defsubst elmo-shimbun-header-set-extra-field (header field-name value)
+  (let ((extras (and header (shimbun-header-extra header)))
+       extra)
+    (if (setq extra (assoc field-name extras))
+       (setcdr extra value)
+      (shimbun-header-set-extra
+       header
+       (cons (cons field-name value) extras)))))
+
 ;; Shimbun mua.
 (eval-and-compile
   (luna-define-class shimbun-elmo-mua (shimbun-mua) (folder))
@@ -74,9 +99,43 @@ See `shimbun-headers' for more detail about RANGE."
 (eval-and-compile
   (luna-define-class elmo-shimbun-folder
                     (elmo-map-folder) (shimbun headers header-hash
+                                               entity-hash
                                                group range last-check))
   (luna-define-internal-accessors 'elmo-shimbun-folder))
 
+(defun elmo-shimbun-folder-entity-hash (folder)
+  (or (elmo-shimbun-folder-entity-hash-internal folder)
+      (let ((overviews (elmo-msgdb-get-overview (elmo-folder-msgdb folder)))
+           hash id)
+       (when overviews
+         (setq hash (elmo-make-hash (length overviews)))
+         (dolist (entity overviews)
+           (elmo-set-hash-val (elmo-msgdb-overview-entity-get-id entity)
+                              entity hash)
+           (when (setq id (elmo-msgdb-overview-entity-get-extra-field
+                           entity "x-original-id"))
+             (elmo-set-hash-val id entity hash)))
+         (elmo-shimbun-folder-set-entity-hash-internal folder hash)))))
+
+(defsubst elmo-shimbun-folder-shimbun-header (folder location)
+  (let ((hash (elmo-shimbun-folder-header-hash-internal folder)))
+    (or (and hash (elmo-get-hash-val location hash))
+       (let ((entity (elmo-msgdb-overview-get-entity
+                      location
+                      (elmo-folder-msgdb folder)))
+             (elmo-hash-minimum-size 63)
+             header)
+         (when entity
+           (setq header (elmo-shimbun-entity-to-header entity))
+           (unless hash
+             (elmo-shimbun-folder-set-header-hash-internal
+              folder
+              (setq hash (elmo-make-hash))))
+           (elmo-set-hash-val (elmo-msgdb-overview-entity-get-id entity)
+                              header
+                              hash)
+           header)))))
+
 (defsubst elmo-shimbun-lapse-seconds (time)
   (let ((now (current-time)))
     (+ (* (- (car now) (car time)) 65536)
@@ -97,53 +156,47 @@ See `shimbun-headers' for more detail about RANGE."
               (elmo-shimbun-folder-last-check-internal folder))
              elmo-shimbun-check-interval))))
 
-(defun elmo-shimbun-msgdb-to-headers (folder expire-days)
-  (let (headers)
-    (dolist (ov (elmo-msgdb-get-overview (elmo-folder-msgdb folder)))
-      (when (and (elmo-msgdb-overview-entity-get-extra-field ov "xref")
-                (if expire-days
-                    (< (elmo-shimbun-lapse-seconds
-                        (elmo-shimbun-parse-time-string
-                         (elmo-msgdb-overview-entity-get-date ov)))
-                       (* expire-days 86400 ; seconds per day
-                          ))
-                  t))
-       (setq headers
-             (cons (shimbun-make-header
-                    (elmo-msgdb-overview-entity-get-number ov)
-                    (shimbun-mime-encode-string
-                     (elmo-msgdb-overview-entity-get-subject ov))
-                    (shimbun-mime-encode-string
-                     (elmo-msgdb-overview-entity-get-from ov))
-                    (elmo-msgdb-overview-entity-get-date ov)
-                    (elmo-msgdb-overview-entity-get-id ov)
-                    (elmo-msgdb-overview-entity-get-references ov)
-                    0
-                    0
-                    (elmo-msgdb-overview-entity-get-extra-field ov "xref"))
-                   headers))))
-    (nreverse headers)))
-
-(defun elmo-shimbun-folder-setup (folder)
-  ;; Resume headers from existing msgdb.
-  (elmo-shimbun-folder-set-headers-internal
-   folder
-   (elmo-shimbun-msgdb-to-headers folder nil))
-  (elmo-shimbun-folder-set-header-hash-internal
-   folder
-   (elmo-make-hash
-    (length (elmo-shimbun-folder-headers-internal folder))))
-  (dolist (header (elmo-shimbun-folder-headers-internal folder))
-    (elmo-set-hash-val
-     (shimbun-header-id header) header
-     (elmo-shimbun-folder-header-hash-internal folder))))
+(defun elmo-shimbun-entity-to-header (entity)
+  (let (message-id shimbun-id)
+    (if (setq message-id (elmo-msgdb-overview-entity-get-extra-field
+                         entity "x-original-id"))
+       (setq shimbun-id (elmo-msgdb-overview-entity-get-id entity))
+      (setq message-id (elmo-msgdb-overview-entity-get-id entity)
+           shimbun-id nil))
+    (elmo-set-work-buf
+     (set-buffer-multibyte t)
+     (shimbun-make-header
+      (elmo-msgdb-overview-entity-get-number entity)
+      (shimbun-mime-encode-string
+       (decode-mime-charset-string
+       (elmo-msgdb-overview-entity-get-subject-no-decode entity)
+       elmo-mime-charset))
+      (shimbun-mime-encode-string
+       (decode-mime-charset-string
+       (elmo-msgdb-overview-entity-get-from-no-decode entity)
+       elmo-mime-charset))
+      (elmo-msgdb-overview-entity-get-date entity)
+      message-id
+      (elmo-msgdb-overview-entity-get-references entity)
+      0
+      0
+      (elmo-msgdb-overview-entity-get-extra-field entity "xref")
+      (and shimbun-id
+          (list (cons "x-shimbun-id" shimbun-id)))))))
+
+(defsubst elmo-shimbun-folder-header-hash-setup (folder headers)
+  (let ((hash (or (elmo-shimbun-folder-header-hash-internal folder)
+                 (elmo-make-hash (length headers)))))
+    (dolist (header headers)
+      (elmo-set-hash-val (shimbun-header-id header) header hash))
+    (elmo-shimbun-folder-set-header-hash-internal folder hash)))
 
 (defun elmo-shimbun-get-headers (folder)
   (let* ((shimbun (elmo-shimbun-folder-shimbun-internal folder))
         (key (concat (shimbun-server-internal shimbun)
                      "." (shimbun-current-group-internal shimbun)))
-        (elmo-hash-minimum-size 0)
-        entry headers hash)
+        (elmo-hash-minimum-size 63)
+        headers)
     ;; new headers.
     (setq headers
          (delq nil
@@ -157,69 +210,59 @@ See `shimbun-headers' for more detail about RANGE."
                 (shimbun-headers
                  (elmo-shimbun-folder-shimbun-internal folder)
                  (elmo-shimbun-folder-range-internal folder)))))
-    (elmo-shimbun-folder-set-headers-internal
-     folder
-     (nconc (elmo-shimbun-msgdb-to-headers
-            folder (shimbun-article-expiration-days
-                    (elmo-shimbun-folder-shimbun-internal folder)))
-           headers))
-    (setq hash
-         (elmo-shimbun-folder-set-header-hash-internal
-          folder
-          (elmo-make-hash
-           (length (elmo-shimbun-folder-headers-internal folder)))))
-    ;; Set up header hash.
-    (dolist (header (elmo-shimbun-folder-headers-internal folder))
-      (elmo-set-hash-val
-       (shimbun-header-id header) header
-       (elmo-shimbun-folder-header-hash-internal folder)))
+    (elmo-shimbun-folder-set-headers-internal folder headers)
+    (when headers
+      (elmo-shimbun-folder-header-hash-setup folder headers))
     (elmo-shimbun-folder-set-last-check-internal folder (current-time))))
 
 (luna-define-method elmo-folder-initialize ((folder
                                             elmo-shimbun-folder)
                                            name)
-  (let ((server-group (if (string-match "\\([^.]+\\)\\." name)
-                         (list (elmo-match-string 1 name)
-                               (substring name (match-end 0)))
-                       (list name))))
-    (when (nth 0 server-group) ; server
-      (elmo-shimbun-folder-set-shimbun-internal
-       folder
-       (shimbun-open (nth 0 server-group)
-                    (luna-make-entity 'shimbun-elmo-mua :folder folder))))
-    (when (nth 1 server-group)
-      (elmo-shimbun-folder-set-group-internal
+  (if (string= name "")
+      folder
+    (let ((server-group (if (string-match "\\([^.]+\\)\\." name)
+                           (list (elmo-match-string 1 name)
+                                 (substring name (match-end 0)))
+                         (list name))))
+      (when (nth 0 server-group) ; server
+       (elmo-shimbun-folder-set-shimbun-internal
+        folder
+        (shimbun-open (nth 0 server-group)
+                      (luna-make-entity 'shimbun-elmo-mua :folder folder))))
+      (when (nth 1 server-group)
+       (elmo-shimbun-folder-set-group-internal
+        folder
+        (nth 1 server-group)))
+      (elmo-shimbun-folder-set-range-internal
        folder
-       (nth 1 server-group)))
-    (elmo-shimbun-folder-set-range-internal
-     folder
-     (or (cdr (elmo-string-matched-assoc (elmo-folder-name-internal folder)
-                                        elmo-shimbun-index-range-alist))
-        elmo-shimbun-default-index-range))
-    folder))
+       (or (cdr (elmo-string-matched-assoc (elmo-folder-name-internal folder)
+                                          elmo-shimbun-index-range-alist))
+          elmo-shimbun-default-index-range))
+      folder)))
 
 (luna-define-method elmo-folder-open-internal ((folder elmo-shimbun-folder))
-  (shimbun-open-group
-   (elmo-shimbun-folder-shimbun-internal folder)
-   (elmo-shimbun-folder-group-internal folder))
-  (let ((inhibit-quit t))
-    (unless (elmo-map-folder-location-alist-internal folder)
-      (elmo-map-folder-location-setup
-       folder
-       (elmo-msgdb-location-load (elmo-folder-msgdb-path folder)))))
-  (cond ((and (elmo-folder-plugged-p folder)
-             (elmo-shimbun-headers-check-p folder))
-        (elmo-shimbun-get-headers folder)
-        (elmo-map-folder-update-locations
-         folder
-         (elmo-map-folder-list-message-locations folder)))
-       ((null (elmo-shimbun-folder-headers-internal folder))
-        ;; Resume headers from existing msgdb.
-        (elmo-shimbun-folder-setup folder))))
+  (when (elmo-shimbun-folder-shimbun-internal folder)
+    (shimbun-open-group
+     (elmo-shimbun-folder-shimbun-internal folder)
+     (elmo-shimbun-folder-group-internal folder))
+    (let ((inhibit-quit t))
+      (unless (elmo-map-folder-location-alist-internal folder)
+       (elmo-map-folder-location-setup
+        folder
+        (elmo-msgdb-location-load (elmo-folder-msgdb-path folder))))
+      (when (and (elmo-folder-plugged-p folder)
+                (elmo-shimbun-headers-check-p folder))
+       (elmo-shimbun-get-headers folder)
+       (elmo-map-folder-update-locations
+        folder
+        (elmo-map-folder-list-message-locations folder))))))
 
 (luna-define-method elmo-folder-reserve-status-p ((folder elmo-shimbun-folder))
   t)
 
+(luna-define-method elmo-folder-local-p ((folder elmo-shimbun-folder))
+  nil)
+
 (luna-define-method elmo-message-use-cache-p ((folder elmo-shimbun-folder)
                                              number)
   elmo-shimbun-use-cache)
@@ -232,15 +275,19 @@ See `shimbun-headers' for more detail about RANGE."
    folder nil)
   (elmo-shimbun-folder-set-header-hash-internal
    folder nil)
+  (elmo-shimbun-folder-set-entity-hash-internal
+   folder nil)
   (elmo-shimbun-folder-set-last-check-internal
    folder nil))
 
 (luna-define-method elmo-folder-plugged-p ((folder elmo-shimbun-folder))
   (elmo-plugged-p
    "shimbun"
-   (shimbun-server-internal (elmo-shimbun-folder-shimbun-internal folder))
+   (and (elmo-shimbun-folder-shimbun-internal folder)
+       (shimbun-server-internal (elmo-shimbun-folder-shimbun-internal folder)))
    nil nil
-   (shimbun-server-internal (elmo-shimbun-folder-shimbun-internal folder))))
+   (and (elmo-shimbun-folder-shimbun-internal folder)
+       (shimbun-server-internal (elmo-shimbun-folder-shimbun-internal folder)))))
 
 (luna-define-method elmo-folder-set-plugged ((folder elmo-shimbun-folder)
                                             plugged &optional add)
@@ -271,6 +318,7 @@ See `shimbun-headers' for more detail about RANGE."
                                               &optional keep-killed)
   (elmo-shimbun-folder-set-headers-internal folder nil)
   (elmo-shimbun-folder-set-header-hash-internal folder nil)
+  (elmo-shimbun-folder-set-entity-hash-internal folder nil)
   (elmo-shimbun-folder-set-last-check-internal folder nil)
   (luna-call-next-method))
 
@@ -281,12 +329,12 @@ See `shimbun-headers' for more detail about RANGE."
            (elmo-shimbun-folder-shimbun-internal folder))
           "/"
           (elmo-shimbun-folder-group-internal folder))
-   (expand-file-name "shimbun" elmo-msgdb-dir)))
+   (expand-file-name "shimbun" elmo-msgdb-directory)))
 
 (defun elmo-shimbun-msgdb-create-entity (folder number)
-  (let ((header (elmo-get-hash-val
-                (elmo-map-message-location folder number)
-                (elmo-shimbun-folder-header-hash-internal folder)))
+  (let ((header (elmo-shimbun-folder-shimbun-header
+                folder
+                (elmo-map-message-location folder number)))
        ov)
     (when header
       (with-temp-buffer
@@ -342,21 +390,69 @@ See `shimbun-headers' for more detail about RANGE."
         'elmo-folder-msgdb-create "Creating msgdb..."
         percent))
       (setq numlist (cdr numlist)))
-    (message "Creating msgdb...done.")
+    (message "Creating msgdb...done")
     (elmo-msgdb-sort-by-date
      (list overview number-alist mark-alist))))
 
 (luna-define-method elmo-folder-message-file-p ((folder elmo-shimbun-folder))
   nil)
 
+(defsubst elmo-shimbun-update-overview (folder shimbun-id header)
+  (let ((entity (elmo-msgdb-overview-get-entity shimbun-id
+                                               (elmo-folder-msgdb folder)))
+       (message-id (shimbun-header-id header))
+       references)
+    (unless (string= shimbun-id message-id)
+      (elmo-msgdb-overview-entity-set-extra-field
+       entity "x-original-id" message-id)
+      (elmo-shimbun-header-set-extra-field
+       header "x-shimbun-id" shimbun-id)
+      (elmo-set-hash-val message-id
+                        entity
+                        (elmo-shimbun-folder-entity-hash folder))
+      (elmo-set-hash-val shimbun-id
+                        entity
+                        (elmo-shimbun-folder-entity-hash folder)))
+    (elmo-msgdb-overview-entity-set-from
+     entity
+     (elmo-mime-string (shimbun-header-from header)))
+    (elmo-msgdb-overview-entity-set-subject
+     entity
+     (elmo-mime-string (shimbun-header-subject header)))
+    (elmo-msgdb-overview-entity-set-date
+     entity (shimbun-header-date header))
+    (when (setq references
+               (or (elmo-msgdb-get-last-message-id
+                    (elmo-field-body "in-reply-to"))
+                   (elmo-msgdb-get-last-message-id
+                    (elmo-field-body "references"))))
+      (elmo-msgdb-overview-entity-set-references
+       entity
+       (or (elmo-msgdb-overview-entity-get-id
+           (elmo-get-hash-val
+            references
+            (elmo-shimbun-folder-entity-hash folder)))
+          references)))))
+
 (luna-define-method elmo-map-message-fetch ((folder elmo-shimbun-folder)
                                            location strategy
                                            &optional section unseen)
   (if (elmo-folder-plugged-p folder)
-      (shimbun-article (elmo-shimbun-folder-shimbun-internal folder)
-                      (elmo-get-hash-val
-                       location
-                       (elmo-shimbun-folder-header-hash-internal folder)))
+      (let ((header (elmo-shimbun-folder-shimbun-header
+                    folder
+                    location))
+           shimbun-id)
+       (shimbun-article (elmo-shimbun-folder-shimbun-internal folder)
+                        header)
+       (when (elmo-string-match-member
+              (elmo-folder-name-internal folder)
+              elmo-shimbun-update-overview-folder-list)
+         (elmo-shimbun-update-overview folder location header))
+       (when (setq shimbun-id
+                   (elmo-shimbun-header-extra-field header "x-shimbun-id"))
+         (goto-char (point-min))
+         (insert (format "X-Shimbun-Id: %s\n" shimbun-id)))
+       t)
     (error "Unplugged")))
 
 (luna-define-method elmo-message-encache :around ((folder
@@ -376,21 +472,63 @@ See `shimbun-headers' for more detail about RANGE."
 
 (luna-define-method elmo-map-folder-list-message-locations
   ((folder elmo-shimbun-folder))
-  (mapcar
-   (function shimbun-header-id)
-   (elmo-shimbun-folder-headers-internal folder)))
+  (let ((expire-days (shimbun-article-expiration-days
+                     (elmo-shimbun-folder-shimbun-internal folder))))
+    (elmo-uniq-list
+     (nconc
+      (delq nil
+           (mapcar
+            (lambda (ov)
+              (when (and (elmo-msgdb-overview-entity-get-extra-field
+                          ov "xref")
+                         (if expire-days
+                             (< (elmo-shimbun-lapse-seconds
+                                 (elmo-shimbun-parse-time-string
+                                  (elmo-msgdb-overview-entity-get-date ov)))
+                                (* expire-days 86400 ; seconds per day
+                                   ))
+                           t))
+                (elmo-msgdb-overview-entity-get-id ov)))
+            (elmo-msgdb-get-overview (elmo-folder-msgdb folder))))
+      (mapcar
+       (lambda (header)
+        (or (elmo-shimbun-header-extra-field header "x-shimbun-id")
+            (shimbun-header-id header)))
+       (elmo-shimbun-folder-headers-internal folder))))))
 
 (luna-define-method elmo-folder-list-subfolders ((folder elmo-shimbun-folder)
                                                 &optional one-level)
-  (unless (elmo-shimbun-folder-group-internal folder)
-    (mapcar
-     (lambda (x)
-       (concat (elmo-folder-prefix-internal folder)
-              (shimbun-server-internal
-               (elmo-shimbun-folder-shimbun-internal folder))
-              "."
-              x))
-     (shimbun-groups (elmo-shimbun-folder-shimbun-internal folder)))))
+  (let ((prefix (elmo-folder-prefix-internal folder)))
+    (cond ((elmo-shimbun-folder-shimbun-internal folder)
+          (unless (elmo-shimbun-folder-group-internal folder)
+            (mapcar
+             (lambda (fld)
+               (concat prefix
+                       (shimbun-server-internal
+                        (elmo-shimbun-folder-shimbun-internal folder))
+                       "." fld))
+             (shimbun-groups (elmo-shimbun-folder-shimbun-internal folder)))))
+         ;; the rest are for "@/" group
+         (one-level
+          (mapcar
+           (lambda (server) (list (concat prefix server)))
+           (shimbun-servers-list)))
+         (t
+          (let (folders)
+            (dolist (server (shimbun-servers-list))
+              (setq folders
+                    (append folders
+                            (mapcar
+                             (lambda (fld) (concat prefix server "." fld))
+                             (shimbun-groups
+                              (shimbun-open server
+                                            (let ((fld
+                                                   (elmo-make-folder
+                                                    (concat prefix server))))
+                                              (luna-make-entity
+                                               'shimbun-elmo-mua
+                                               :folder fld))))))))
+            folders)))))
 
 (luna-define-method elmo-folder-exists-p ((folder elmo-shimbun-folder))
   (if (elmo-shimbun-folder-group-internal folder)
@@ -401,10 +539,6 @@ See `shimbun-headers' for more detail about RANGE."
                          folder))))
     t))
 
-(luna-define-method elmo-folder-search ((folder elmo-shimbun-folder)
-                                       condition &optional from-msgs)
-  nil)
-
 ;;; To override elmo-map-folder methods.
 (luna-define-method elmo-folder-list-unreads-internal
   ((folder elmo-shimbun-folder) unread-marks &optional mark-alist)
@@ -429,4 +563,4 @@ See `shimbun-headers' for more detail about RANGE."
 (require 'product)
 (product-provide (provide 'elmo-shimbun) (require 'elmo-version))
 
-;;; elmo-shimbun.el ends here
\ No newline at end of file
+;;; elmo-shimbun.el ends here