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
94 (split-string (expand-file-name
95 (elmo-localdir-folder-dir-name-internal folder))
98 (expand-file-name ;;"localdir"
99 (symbol-name (elmo-folder-type-internal folder))
100 elmo-msgdb-directory)))
102 (luna-define-method elmo-message-file-name ((folder
103 elmo-localdir-folder)
105 (expand-file-name (int-to-string number)
106 (elmo-localdir-folder-directory-internal folder)))
108 (luna-define-method elmo-folder-message-file-number-p ((folder
109 elmo-localdir-folder))
112 (luna-define-method elmo-folder-message-file-directory ((folder
113 elmo-localdir-folder))
114 (elmo-localdir-folder-directory-internal folder))
116 (luna-define-method elmo-folder-message-make-temp-file-p
117 ((folder elmo-localdir-folder))
120 (luna-define-method elmo-folder-message-make-temp-files ((folder
121 elmo-localdir-folder)
125 (let ((temp-dir (elmo-folder-make-temporary-directory folder))
126 (cur-number (or start-number 0)))
127 (dolist (number numbers)
130 (int-to-string number)
131 (elmo-localdir-folder-directory-internal folder))
133 (int-to-string (if start-number cur-number number))
138 (defun elmo-localdir-msgdb-create-entity (dir number)
139 (elmo-msgdb-create-overview-entity-from-file
140 number (expand-file-name (int-to-string number) dir)))
142 (luna-define-method elmo-folder-msgdb-create ((folder elmo-localdir-folder)
150 (let ((dir (elmo-localdir-folder-directory-internal folder))
151 overview number-alist mark-alist entity message-id
154 (len (length numbers)))
155 (message "Creating msgdb...")
158 (elmo-localdir-msgdb-create-entity
162 (setq num (elmo-msgdb-overview-entity-get-number entity))
164 (elmo-msgdb-append-element
166 (setq message-id (elmo-msgdb-overview-entity-get-id entity))
168 (elmo-msgdb-number-add number-alist
171 (setq seen (member message-id seen-list))
172 (if (setq gmark (or (elmo-msgdb-global-mark-get message-id)
173 (if (elmo-file-cache-exists-p message-id) ; XXX
181 (elmo-msgdb-mark-append
185 (when (> len elmo-display-progress-threshold)
187 (elmo-display-progress
188 'elmo-localdir-msgdb-create-as-numbers "Creating msgdb..."
190 (setq numbers (cdr numbers)))
191 (message "Creating msgdb...done")
192 (list overview number-alist mark-alist))))
194 (luna-define-method elmo-folder-list-subfolders ((folder elmo-localdir-folder)
196 (elmo-mapcar-list-of-list
197 (lambda (x) (concat (elmo-folder-prefix-internal folder) x))
198 (elmo-list-subdirectories
199 (elmo-localdir-folder-path folder)
200 (or (elmo-localdir-folder-dir-name-internal folder) "")
203 (defsubst elmo-localdir-list-subr (folder &optional nonsort)
204 (let ((flist (mapcar 'string-to-int
206 (elmo-localdir-folder-directory-internal folder)
208 (killed (elmo-msgdb-killed-list-load (elmo-folder-msgdb-path folder))))
210 (cons (or (elmo-max-of-list flist) 0)
213 (elmo-msgdb-killed-list-length killed))
217 (luna-define-method elmo-folder-append-buffer ((folder elmo-localdir-folder)
220 (let ((filename (elmo-message-file-name
223 (1+ (car (elmo-folder-status folder)))))))
224 (when (file-writable-p filename)
225 (write-region-as-binary
226 (point-min) (point-max) filename nil 'no-msg)
229 (luna-define-method elmo-folder-append-messages :around
230 ((folder elmo-localdir-folder)
231 src-folder numbers unread-marks &optional same-number)
232 (if (elmo-folder-message-file-p src-folder)
233 (let ((dir (elmo-localdir-folder-directory-internal folder))
235 (next-num (1+ (car (elmo-folder-status folder)))))
238 (elmo-message-file-name src-folder (car numbers))
241 (if same-number (car numbers) next-num))
243 (elmo-progress-notify 'elmo-folder-move-messages)
244 (if (and (setq numbers (cdr numbers))
247 (if (elmo-localdir-locked-p)
249 (1+ (car (elmo-folder-status folder)))
252 (luna-call-next-method)))
254 (luna-define-method elmo-folder-delete-messages ((folder elmo-localdir-folder)
256 (dolist (number numbers)
257 (elmo-localdir-delete-message folder number))
260 (defun elmo-localdir-delete-message (folder number)
261 "Delete message in the FOLDER with NUMBER."
262 (let ((filename (elmo-message-file-name folder number)))
263 (when (and (string-match "[0-9]+" filename) ; for safety.
264 (file-exists-p filename)
265 (file-writable-p filename)
266 (not (file-directory-p filename)))
267 (delete-file filename)
270 (luna-define-method elmo-message-fetch-internal ((folder elmo-localdir-folder)
272 &optional section unread)
273 (when (file-exists-p (elmo-message-file-name folder number))
274 (insert-file-contents-as-binary
275 (elmo-message-file-name folder number))))
277 (luna-define-method elmo-folder-list-messages-internal
278 ((folder elmo-localdir-folder) &optional nohide)
279 (elmo-localdir-list-subr folder))
281 (luna-define-method elmo-folder-status ((folder elmo-localdir-folder))
282 (elmo-localdir-list-subr folder t))
284 (luna-define-method elmo-folder-creatable-p ((folder elmo-localdir-folder))
287 (luna-define-method elmo-folder-writable-p ((folder elmo-localdir-folder))
290 (luna-define-method elmo-folder-create ((folder elmo-localdir-folder))
291 (let ((dir (elmo-localdir-folder-directory-internal folder)))
292 (if (file-directory-p dir)
294 (if (file-exists-p dir)
295 (error "Create folder failed")
296 (elmo-make-directory dir))
299 (luna-define-method elmo-folder-delete :before ((folder elmo-localdir-folder))
300 (let ((dir (elmo-localdir-folder-directory-internal folder)))
301 (if (not (file-directory-p dir))
302 (error "No such directory: %s" dir)
303 (elmo-delete-match-files dir "[0-9]+" t)
306 (luna-define-method elmo-folder-rename-internal ((folder elmo-localdir-folder)
308 (let* ((old (elmo-localdir-folder-directory-internal folder))
309 (new (elmo-localdir-folder-directory-internal new-folder))
310 (new-dir (directory-file-name (file-name-directory new))))
311 (if (not (file-directory-p old))
312 (error "No such directory: %s" old)
313 (if (file-exists-p new)
314 (error "Already exists directory: %s" new)
315 (if (not (file-directory-p new-dir))
316 (elmo-make-directory new-dir))
317 (rename-file old new)
320 (defsubst elmo-localdir-field-condition-match (folder condition
322 (elmo-file-field-condition-match
323 (expand-file-name (int-to-string number)
324 (elmo-localdir-folder-directory-internal folder))
325 condition number number-list))
327 (luna-define-method elmo-folder-pack-numbers ((folder elmo-localdir-folder))
328 (let* ((dir (elmo-localdir-folder-directory-internal folder))
329 (msgdb (elmo-folder-msgdb folder))
330 (onum-alist (elmo-msgdb-get-number-alist msgdb))
331 (omark-alist (elmo-msgdb-get-mark-alist msgdb))
332 (new-number 1) ; first ordinal position in localdir
333 flist onum mark new-mark-alist total)
335 (if elmo-pack-number-check-strict
336 (elmo-folder-list-messages folder) ; allow localnews
337 (mapcar 'car onum-alist)))
338 (setq total (length flist))
340 (when (> total elmo-display-progress-threshold)
341 (elmo-display-progress
342 'elmo-folder-pack-numbers "Packing..."
343 (/ (* new-number 100) total)))
344 (setq onum (car flist))
345 (when (not (eq onum new-number)) ; why \=() is wrong..
349 (rename-file (int-to-string onum) (int-to-string new-number) t))
351 (elmo-msgdb-overview-entity-set-number
352 (elmo-msgdb-overview-get-entity onum msgdb)
354 ;; update number-alist
355 (setcar (assq onum onum-alist) new-number))
357 (when (setq mark (cadr (assq onum omark-alist)))
359 (elmo-msgdb-mark-append
362 (setq new-number (1+ new-number))
363 (setq flist (cdr flist)))
364 (message "Packing...done")
365 (elmo-folder-set-msgdb-internal
368 (elmo-msgdb-get-overview msgdb)
372 (luna-define-method elmo-folder-message-file-p ((folder elmo-localdir-folder))
375 (luna-define-method elmo-message-file-name ((folder elmo-localdir-folder)
378 (int-to-string number)
379 (elmo-localdir-folder-directory-internal folder)))
381 (defun elmo-localdir-locked-p ()
382 (if elmo-localdir-lockfile-list
383 (let ((lock elmo-localdir-lockfile-list))
386 (if (file-exists-p (car lock))
388 (setq lock (cdr lock)))))))
391 (product-provide (provide 'elmo-localdir) (require 'elmo-version))
393 ;;; elmo-localdir.el ends here