1 ;;; elmo-localdir.el --- Localdir Interface for ELMO.
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
4 ;; Copyright (C) 1998,1999,2000 Masahiro MURATA <muse@ba2.so-net.ne.jp>
5 ;; Copyright (C) 1999,2000 Kenichi OKADA <okada@opaopa.org>
7 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
8 ;; Masahiro MURATA <muse@ba2.so-net.ne.jp>
9 ;; Kenichi OKADA <okada@opaopa.org>
10 ;; Keywords: mail, net news
12 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
14 ;; This program is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; This program is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
35 (eval-when-compile (require 'cl))
40 (defcustom elmo-localdir-folder-path "~/Mail"
41 "*Local mail directory (MH format) path."
45 (defvar elmo-localdir-lockfile-list nil)
47 ;;; ELMO Local directory folder
49 (luna-define-class elmo-localdir-folder (elmo-folder)
51 (luna-define-internal-accessors 'elmo-localdir-folder))
53 ;;; elmo-localdir specific methods.
54 (luna-define-generic elmo-localdir-folder-path (folder)
55 "Return local directory path of the FOLDER.")
57 (luna-define-generic elmo-localdir-folder-name (folder name)
58 "Return directory NAME for FOLDER.")
60 (luna-define-method elmo-localdir-folder-path ((folder elmo-localdir-folder))
61 elmo-localdir-folder-path)
63 (luna-define-method elmo-localdir-folder-name ((folder elmo-localdir-folder)
67 (luna-define-method elmo-folder-initialize ((folder
70 (elmo-localdir-folder-set-dir-name-internal folder name)
71 (if (file-name-absolute-p name)
72 (elmo-localdir-folder-set-directory-internal
74 (expand-file-name name))
75 (elmo-localdir-folder-set-directory-internal
78 (elmo-localdir-folder-name folder name)
79 (elmo-localdir-folder-path folder))))
82 ;; open, check, commit, and close are generic.
84 (luna-define-method elmo-folder-exists-p ((folder elmo-localdir-folder))
85 (file-directory-p (elmo-localdir-folder-directory-internal folder)))
87 (luna-define-method elmo-folder-expand-msgdb-path ((folder
88 elmo-localdir-folder))
93 'elmo-replace-string-as-filename
95 (let ((dir-name (elmo-localdir-folder-dir-name-internal folder)))
96 (if (file-name-absolute-p dir-name)
97 (expand-file-name dir-name)
101 (expand-file-name ;;"localdir"
102 (symbol-name (elmo-folder-type-internal folder))
103 elmo-msgdb-directory)))
105 (luna-define-method elmo-message-file-name ((folder
106 elmo-localdir-folder)
108 (expand-file-name (int-to-string number)
109 (elmo-localdir-folder-directory-internal folder)))
111 (luna-define-method elmo-folder-message-file-number-p ((folder
112 elmo-localdir-folder))
115 (luna-define-method elmo-folder-message-file-directory ((folder
116 elmo-localdir-folder))
117 (elmo-localdir-folder-directory-internal folder))
119 (luna-define-method elmo-folder-message-make-temp-file-p
120 ((folder elmo-localdir-folder))
123 (luna-define-method elmo-folder-message-make-temp-files ((folder
124 elmo-localdir-folder)
128 (let ((temp-dir (elmo-folder-make-temporary-directory folder))
129 (cur-number (or start-number 0)))
130 (dolist (number numbers)
133 (int-to-string number)
134 (elmo-localdir-folder-directory-internal folder))
136 (int-to-string (if start-number cur-number number))
141 (defun elmo-localdir-msgdb-create-entity (dir number)
142 (elmo-msgdb-create-overview-entity-from-file
143 number (expand-file-name (int-to-string number) dir)))
145 (luna-define-method elmo-folder-msgdb-create ((folder elmo-localdir-folder)
149 (let ((dir (elmo-localdir-folder-directory-internal folder))
150 (new-msgdb (elmo-make-msgdb))
153 (len (length numbers)))
154 (message "Creating msgdb...")
157 (elmo-localdir-msgdb-create-entity
160 (setq message-id (elmo-msgdb-overview-entity-get-id entity))
161 (elmo-msgdb-append-entity
164 (elmo-flag-table-get flag-table message-id)))
165 (when (> len elmo-display-progress-threshold)
167 (elmo-display-progress
168 'elmo-localdir-msgdb-create-as-numbers "Creating msgdb..."
170 (setq numbers (cdr numbers)))
171 (message "Creating msgdb...done")
174 (luna-define-method elmo-folder-list-subfolders ((folder elmo-localdir-folder)
176 (elmo-mapcar-list-of-list
177 (lambda (x) (concat (elmo-folder-prefix-internal folder) x))
178 (elmo-list-subdirectories
179 (elmo-localdir-folder-path folder)
180 (or (elmo-localdir-folder-dir-name-internal folder) "")
183 (defsubst elmo-localdir-list-subr (folder &optional nonsort)
184 (let ((flist (mapcar 'string-to-int
186 (elmo-localdir-folder-directory-internal folder)
188 (killed (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder))))
190 (cons (or (elmo-max-of-list flist) 0)
193 (elmo-msgdb-killed-list-length killed))
197 (luna-define-method elmo-folder-append-buffer ((folder elmo-localdir-folder)
200 (let ((filename (elmo-message-file-name
203 (1+ (car (elmo-folder-status folder)))))))
204 (when (file-writable-p filename)
205 (write-region-as-binary
206 (point-min) (point-max) filename nil 'no-msg)
209 (luna-define-method elmo-folder-append-messages :around
210 ((folder elmo-localdir-folder)
211 src-folder numbers &optional same-number)
212 (if (elmo-folder-message-file-p src-folder)
213 (let ((src-msgdb-exists (not (zerop (elmo-folder-length src-folder))))
214 (dir (elmo-localdir-folder-directory-internal folder))
215 (table (elmo-flag-table-load (elmo-folder-msgdb-path folder)))
217 (next-num (1+ (car (elmo-folder-status folder))))
220 (setq flags (elmo-message-flags src-folder (car numbers)))
222 (elmo-message-file-name src-folder (car numbers))
225 (if same-number (car numbers) next-num))
227 ;; save flag-table only when src folder's msgdb is loaded.
228 (when (setq id (and src-msgdb-exists
229 (elmo-message-field src-folder (car numbers)
231 (elmo-flag-table-set table id flags))
232 (elmo-progress-notify 'elmo-folder-move-messages)
233 (if (and (setq numbers (cdr numbers))
236 (if (elmo-localdir-locked-p)
238 (1+ (car (elmo-folder-status folder)))
240 (when (elmo-folder-persistent-p folder)
241 (elmo-flag-table-save (elmo-folder-msgdb-path folder) table))
243 (luna-call-next-method)))
245 (luna-define-method elmo-folder-delete-messages ((folder elmo-localdir-folder)
247 (dolist (number numbers)
248 (elmo-localdir-delete-message folder number))
251 (defun elmo-localdir-delete-message (folder number)
252 "Delete message in the FOLDER with NUMBER."
253 (let ((filename (elmo-message-file-name folder number)))
254 (when (and (string-match "[0-9]+" filename) ; for safety.
255 (file-exists-p filename)
256 (file-writable-p filename)
257 (not (file-directory-p filename)))
258 (delete-file filename)
261 (luna-define-method elmo-message-fetch-internal ((folder elmo-localdir-folder)
263 &optional section unread)
264 (when (file-exists-p (elmo-message-file-name folder number))
265 (insert-file-contents-as-binary
266 (elmo-message-file-name folder number))))
268 (luna-define-method elmo-folder-list-messages-internal
269 ((folder elmo-localdir-folder) &optional nohide)
270 (elmo-localdir-list-subr folder))
272 (luna-define-method elmo-folder-status ((folder elmo-localdir-folder))
273 (elmo-localdir-list-subr folder t))
275 (luna-define-method elmo-folder-creatable-p ((folder elmo-localdir-folder))
278 (luna-define-method elmo-folder-writable-p ((folder elmo-localdir-folder))
281 (luna-define-method elmo-folder-create ((folder elmo-localdir-folder))
282 (let ((dir (elmo-localdir-folder-directory-internal folder)))
283 (if (file-directory-p dir)
285 (if (file-exists-p dir)
286 (error "Create folder failed")
287 (elmo-make-directory dir))
290 (luna-define-method elmo-folder-delete ((folder elmo-localdir-folder))
291 (let ((msgs (and (elmo-folder-exists-p folder)
292 (elmo-folder-list-messages folder))))
293 (when (yes-or-no-p (format "%sDelete msgdb and substance of \"%s\"? "
294 (if (> (length msgs) 0)
295 (format "%d msg(s) exists. " (length msgs))
297 (elmo-folder-name-internal folder)))
298 (let ((dir (elmo-localdir-folder-directory-internal folder)))
299 (if (not (file-directory-p dir))
300 (error "No such directory: %s" dir)
301 (elmo-delete-match-files dir "[0-9]+" t)))
302 (elmo-msgdb-delete-path folder)
305 (luna-define-method elmo-folder-rename-internal ((folder elmo-localdir-folder)
307 (let* ((old (elmo-localdir-folder-directory-internal folder))
308 (new (elmo-localdir-folder-directory-internal new-folder))
309 (new-dir (directory-file-name (file-name-directory new))))
310 (unless (file-directory-p old)
311 (error "No such directory: %s" old))
312 (when (file-exists-p new)
313 (error "Already exists directory: %s" new))
314 (unless (file-directory-p new-dir)
315 (elmo-make-directory new-dir))
316 (rename-file old new)
319 (defsubst elmo-localdir-field-condition-match (folder condition
321 (elmo-file-field-condition-match
322 (expand-file-name (int-to-string number)
323 (elmo-localdir-folder-directory-internal folder))
324 condition number number-list))
326 (luna-define-method elmo-folder-pack-numbers ((folder elmo-localdir-folder))
327 (let* ((dir (elmo-localdir-folder-directory-internal folder))
328 (msgdb (elmo-folder-msgdb folder))
329 (new-msgdb (elmo-make-msgdb (elmo-folder-msgdb-path folder)))
330 (numbers (sort (elmo-folder-list-messages
333 (not elmo-pack-number-check-strict))
335 (new-number 1) ; first ordinal position in localdir
337 (setq total (length numbers))
338 (elmo-with-progress-display (> total elmo-display-progress-threshold)
339 (elmo-folder-pack-numbers total "Packing...")
340 (dolist (old-number numbers)
341 (setq entity (elmo-msgdb-message-entity msgdb old-number))
342 (when (not (eq old-number new-number)) ; why \=() is wrong..
346 (rename-file (int-to-string old-number)
347 (int-to-string new-number) t))
348 (elmo-msgdb-overview-entity-set-number entity new-number))
349 (elmo-msgdb-append-entity new-msgdb entity
350 (elmo-msgdb-flags msgdb old-number))
351 (setq new-number (1+ new-number))))
352 (message "Packing...done")
353 (elmo-folder-set-msgdb-internal folder new-msgdb)))
355 (luna-define-method elmo-folder-message-file-p ((folder elmo-localdir-folder))
358 (luna-define-method elmo-message-file-name ((folder elmo-localdir-folder)
361 (int-to-string number)
362 (elmo-localdir-folder-directory-internal folder)))
364 (defun elmo-localdir-locked-p ()
365 (if elmo-localdir-lockfile-list
366 (let ((lock elmo-localdir-lockfile-list))
369 (if (file-exists-p (car lock))
371 (setq lock (cdr lock)))))))
374 (product-provide (provide 'elmo-localdir) (require 'elmo-version))
376 ;;; elmo-localdir.el ends here