Merged the change of elmo-mark branch at 2003-08-30.
[elisp/wanderlust.git] / elmo / elmo-cache.el
1 ;;; elmo-cache.el --- Cache modules for ELMO.
2
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
4 ;; Copyright (C) 2000 Kenichi OKADA <okada@opaopa.org>
5
6 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
7 ;;      Kenichi OKADA <okada@opaopa.org>
8 ;; Keywords: mail, net news
9
10 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
11
12 ;; This program is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16 ;;
17 ;; This program is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 ;; GNU General Public License for more details.
21 ;;
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
26 ;;
27
28 ;;; Commentary:
29 ;;
30
31 ;;; Code:
32 ;;
33 (require 'elmo-vars)
34 (require 'elmo-util)
35 (require 'elmo)
36 (require 'elmo-map)
37
38 (eval-and-compile
39   (luna-define-class elmo-cache-folder (elmo-map-folder) (dir-name directory))
40   (luna-define-internal-accessors 'elmo-cache-folder))
41
42 (luna-define-method elmo-folder-initialize ((folder elmo-cache-folder)
43                                             name)
44   (when (string-match "\\([^/]*\\)/?\\(.*\\)$" name)
45     (elmo-cache-folder-set-dir-name-internal
46      folder
47      (elmo-match-string 2 name))
48     (elmo-cache-folder-set-directory-internal
49      folder
50      (expand-file-name (elmo-match-string 2 name)
51                        elmo-cache-directory))
52     folder))
53
54 (luna-define-method elmo-folder-expand-msgdb-path ((folder elmo-cache-folder))
55   (expand-file-name (elmo-cache-folder-dir-name-internal folder)
56                     (expand-file-name "internal/cache"
57                                       elmo-msgdb-directory)))
58
59 (luna-define-method elmo-map-folder-list-message-locations
60   ((folder elmo-cache-folder))
61   (elmo-cache-folder-list-message-locations folder))
62
63 (defun elmo-cache-folder-list-message-locations (folder)
64   (mapcar 'file-name-nondirectory
65           (elmo-delete-if
66            'file-directory-p
67            (directory-files (elmo-cache-folder-directory-internal folder)
68                             t "^[^@]+@[^@]+$" t))))
69
70 (luna-define-method elmo-folder-list-subfolders ((folder elmo-cache-folder)
71                                                  &optional one-level)
72   (delq nil (mapcar
73              (lambda (f) (if (file-directory-p f)
74                              (concat (elmo-folder-prefix-internal folder)
75                                      "cache/"
76                                      (file-name-nondirectory f))))
77              (directory-files (elmo-cache-folder-directory-internal folder)
78                               t "^[^.].*+"))))
79
80 (luna-define-method elmo-folder-message-file-p ((folder elmo-cache-folder))
81   t)
82
83 (luna-define-method elmo-message-file-name ((folder elmo-cache-folder)
84                                             number)
85   (expand-file-name
86    (elmo-map-message-location folder number)
87    (elmo-cache-folder-directory-internal folder)))
88
89 (luna-define-method elmo-folder-msgdb-create ((folder elmo-cache-folder)
90                                               numbers flag-table)
91   (let ((i 0)
92         (len (length numbers))
93         (new-msgdb (elmo-make-msgdb))
94         entity message-id mark)
95     (message "Creating msgdb...")
96     (while numbers
97       (setq entity
98             (elmo-msgdb-create-overview-entity-from-file
99              (car numbers) (elmo-message-file-name folder (car numbers))))
100       (when entity
101         (setq message-id (elmo-msgdb-overview-entity-get-id entity))
102         (setq mark (or (elmo-msgdb-global-mark-get message-id)
103                        (elmo-msgdb-mark
104                         (elmo-flag-table-get flag-table message-id)
105                         (elmo-file-cache-status
106                          (elmo-file-cache-get message-id))
107                         'new)))
108         (elmo-msgdb-append-entity new-msgdb entity mark))
109       (when (> len elmo-display-progress-threshold)
110         (setq i (1+ i))
111         (elmo-display-progress
112          'elmo-cache-folder-msgdb-create "Creating msgdb..."
113          (/ (* i 100) len)))
114       (setq numbers (cdr numbers)))
115     (message "Creating msgdb...done")
116     new-msgdb))
117
118 (luna-define-method elmo-folder-append-buffer ((folder elmo-cache-folder)
119                                                &optional flag number)
120   ;; dir-name is changed according to msgid.
121   (unless (elmo-cache-folder-dir-name-internal folder)
122     (let* ((file (elmo-file-cache-get-path (std11-field-body "message-id")))
123            (dir (directory-file-name (file-name-directory file))))
124       (unless (file-exists-p dir)
125         (elmo-make-directory dir))
126       (when (file-writable-p file)
127         (write-region-as-binary
128          (point-min) (point-max) file nil 'no-msg))))
129   t)
130
131 (luna-define-method elmo-map-folder-delete-messages ((folder elmo-cache-folder)
132                                                      locations)
133   (dolist (location locations)
134     (elmo-file-cache-delete
135      (expand-file-name location
136                        (elmo-cache-folder-directory-internal folder)))))
137
138 (luna-define-method elmo-message-fetch-with-cache-process
139   ((folder elmo-cache-folder) number strategy &optional section unseen)
140   ;; disbable cache process
141   (elmo-message-fetch-internal folder number strategy section unseen))
142
143 (luna-define-method elmo-map-message-fetch ((folder elmo-cache-folder)
144                                             location strategy
145                                             &optional section unseen)
146   (let ((file (expand-file-name
147                location
148                (elmo-cache-folder-directory-internal folder))))
149     (when (file-exists-p file)
150       (insert-file-contents-as-binary file))))
151
152 (luna-define-method elmo-folder-writable-p ((folder elmo-cache-folder))
153   t)
154
155 (luna-define-method elmo-folder-exists-p ((folder elmo-cache-folder))
156   t)
157
158 (luna-define-method elmo-message-file-p ((folder elmo-cache-folder) number)
159   t)
160
161 (require 'product)
162 (product-provide (provide 'elmo-cache) (require 'elmo-version))
163
164 ;;; elmo-cache.el ends here